diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index a9c0c88..d982e35 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -31,7 +31,7 @@ jobs: - name: Generate website (XSLT) id: generate # Override Maven properties for the Petal button url - run: mvn -B -Dpetal.api-url=https://dev.petal.evolvedbinary.com -Dpetal.github-org-name=evolvedbinary -Dpetal.github-repo-name=cityehr-documentation -Dpetal.github-branch=develop -Dpetal.referrer-base-url=https://evolvedbinary.github.io/cityehr-documentation package -Pquick-start-guide-website + run: mvn -B -Dpetal.api-url=https://petal.evolvedbinary.com -Dpetal.github-org-name=evolvedbinary -Dpetal.github-repo-name=cityehr-documentation -Dpetal.github-branch=develop -Dpetal.referrer-base-url=https://evolvedbinary.github.io/cityehr-documentation package -Pquick-start-guide-website - name: Setup Pages uses: actions/configure-pages@v5 - name: Upload pages artifact diff --git a/cityehr-quick-start-guide/src/main/lwdita/quickstart-guide-modular/download-user-resources.dita b/cityehr-quick-start-guide/src/main/lwdita/quickstart-guide-modular/download-user-resources.dita index c158d63..b02e36b 100644 --- a/cityehr-quick-start-guide/src/main/lwdita/quickstart-guide-modular/download-user-resources.dita +++ b/cityehr-quick-start-guide/src/main/lwdita/quickstart-guide-modular/download-user-resources.dita @@ -1,21 +1,21 @@ - + Download User Resources

Some of the features you will encounter later on in this Quick Start Guide will require the use of resources, such as sample patient records or information models. A set of useful resources is shipped with cityEHR and can be downloaded for your use.

-

These user resources are accessible for download from the Administration page, which is - accessed by pressing the Administration button on the System Navigation menu (top right - of the page).

+

The download button is under settings resources 

  1. Click the Administration button (top right) to access the Administration page

  2. On the Administration page, in the menu in the left hand pane, select the menu option “Manage System Parameters” from the System menu.

    -

    Download User Resources from Administration Page

    +

    + Download User Resources from Administration Page +

  3. At the top right of this view, click the button to Download Resources, as shown @@ -23,7 +23,9 @@

  4. The zip file of resources should now download to your browser and be accessible through your Downloads (exactly how, may depend on the set up for your browser).

    -

    Zip Archive of User Resources Downloaded to Browser

    +

    + Zip Archive of User Resources Downloaded to Browser +

  5. Open the zip file and you should now have access to the folders and files shipped @@ -34,7 +36,9 @@

    The full set of resources should be similar to the list shown in the figure below (this is shown using the Linux Archive Manager — yours may look a bit different, depending on how your machine is set up to handle .zip archives).

    -

    User Resources Zip Archive

    +

    + User Resources Zip Archive +

diff --git a/cityehr-quick-start-guide/src/main/lwdita/quickstart-guide-modular/verify-install.dita b/cityehr-quick-start-guide/src/main/lwdita/quickstart-guide-modular/verify-install.dita index 1af0945..4852db0 100644 --- a/cityehr-quick-start-guide/src/main/lwdita/quickstart-guide-modular/verify-install.dita +++ b/cityehr-quick-start-guide/src/main/lwdita/quickstart-guide-modular/verify-install.dita @@ -1,5 +1,5 @@ - + Verifying the installation This topic confirms that cityEHR is correctly installed and accessible. It covers logging in to cityEHR using default credentials, building the default application, and navigating the Dashboard to review key system elements. Additionally, the chapter explains how to reload the default application if necessary, run cityEHR in debug mode to explore its underlying structures, and handle session timeouts. This chapter ensures users can successfully set up and verify the functionality of cityEHR before moving on to more advanced configurations. @@ -8,36 +8,46 @@ Log On

With Apache Tomcat and cityEHR installed, the log-on page of cityEHR can be accessed with the Firefox web browser using the address http://localhost:8080/cityehr if you have the Tomcat server running on your local machine or if running on a remote server, substitute the IP address of your server for 'localhost'.

Note that cityEHR 1.7 must be accessed using Firefox only (IE 11, Edge, Chrome and Safari will be supported from version 2.0 onwards).

-

The base cityEHR installation has a single default user set up with the credentials

+

The base cityEHR installation small change has a single default user set up with the credentials

username: admin

password: password

-

cityEHR Log-on Page

+

+ cityEHR Log-on Page +

When you log onto cityEHR for the very first time using the credentials above, cityEHR can build a default application, with an example information model and configuration. You will be prompted to build the default application or start with an empty database; choose the option to build a default application.

- - -

Initialize New cityEHR Installation

+

+ Initialize New cityEHR Installation +

cityEHR will now run through a sequence of steps to build the default application; while this is in progress the screen will look like the one displayed in the Figure below. It take a minute or so for this process to complete, so you will need to wait while before continuing.

-

Default Application Sequence Steps

+

+ Default Application Sequence Steps +

After the default application has been built during your first log-on, and for every other time you log on, the screen will be as shown in the Figure below, after you have authenticated:

-

Post Authentication Page +

+ Post Authentication Page +

Press the Start button to move to the default home page, which is pre-configured to be the dashboard page, as shown in the figure below

The Dashboard shows a summary of the overall status of the cityEHR application, which ships by default with the base installation. There is one user registered (the 'admin' user you logged in as) and no patients (so the total patients is zero, there are no clinical documents recorded and no documents in progress).

Note: The number of Information Models shown in the dashboard. If this number is zero (0) then the default application was not loaded properly when you ran cityEHR for the first time (probably because you selected to "Use Empty Database".

-

Default Home-page Dashboard +

+ Default Home-page Dashboard +

The Dashboard is your first glimpse of the pages in cityEHR, which can either be non-patient (like the Dashboard), cross-patient (the Patient Search page, for example) or patient specific (view of the record for a patient, as identified in the Patient Label)

Whichever type, the general layout of all pages in the cityEHR system is the same, as shown in the figure below.

-

System Page Layout +

+ System Page Layout +

@@ -59,7 +69,9 @@

Now wait while the models are reloaded (which may take a few minutes) - progress is displayed in the main view. Once completed, the progress display will be cleared and you should see a summary of the models as shown in the Figure below.

-

Information Model Summary

+

+ Information Model Summary +

Running in Debug Mode @@ -91,7 +103,9 @@

-

Edit system parameters to set Debug Mode +

+ Edit system parameters to set Debug Mode +

You can now restart a new session in debug mode

@@ -112,30 +126,44 @@

Running in Debug Mode allows the user access to additional features that expose some of the underlying information structures in cityEHR.

On the Sign On page, as shown in the Figure below, various of the internal XML instances, built during the log on process, are available to view by selecting in the Debug Info drop down and then pressing the Debug button.

-

cityEHR start-up in Debugging mode +

+ cityEHR start-up in Debugging mode +

On patient-specific data input pages (Forms, Letters, etc) pressing the XML button will bring up a dialog box with a listing of the current HL7 CDA document associated with the data input form. This dialog also has a button to Download the HL7 CDA XML.

-

XML viewer open for DAS 28 Form

+

+ XML viewer open for DAS 28 Form +

Also on patient-specific data input pages are check boxes to Display ISO 13606 structure or to show the Identifiers for the ISO 13606 components on the form.

-

Showing ISO 13606 Structure in Debug Mode

+

+ Showing ISO 13606 Structure in Debug Mode +

-

Showing ISO 13606 Component Ids in Debug Mode

+

+ Showing ISO 13606 Component Ids in Debug Mode +

Session Time Out

The cityEHR session is set to time out after a period on inactivity – this is controlled by the underlying session management of the Tomcat application server. If such a timeout occurs you will see an error dialogue which allows you to restart the application.

-

Session Time Out Dialogue +

+ Session Time Out Dialogue +

In addition, there is a session page load time limit which restricts the ability to refresh pages using the browser “reload current page” button. This limit is set by default at 10 minutes, but can be changed in the Admin page (System Parameters) if necessary. A change from the duration P10M (10 minutes) to PT1M (1 minute) is shown in

If the browser reload page button is pressed within this time limit, then the page will reload as requested; outside the time limit the session will simply return to the sign on page.

This means that it is not possible to copy and paste the URL of a cityEHR session or to bookmark a page (the URL will be invalid once the session page load time limit has expired).

Logging in after a session has expired (i.e. a session that was not Quit by the user) will prompt for the session to be resumed at the point the previous session timed out or was aborted.

-

Changing the Page Load Timeout on the Administration Page

-

Prompt to Resume Session on the Sign On Page

+

+ Changing the Page Load Timeout on the Administration Page +

+

+ Prompt to Resume Session on the Sign On Page +

diff --git a/cityehr-quick-start-guide/src/main/xslt/create-topic-html.xslt b/cityehr-quick-start-guide/src/main/xslt/create-topic-html.xslt index 8b26052..3cd1cd2 100644 --- a/cityehr-quick-start-guide/src/main/xslt/create-topic-html.xslt +++ b/cityehr-quick-start-guide/src/main/xslt/create-topic-html.xslt @@ -37,11 +37,11 @@ - +
- +
diff --git a/cityehr-quick-start-guide/src/main/xslt/create-topic-pdf.xslt b/cityehr-quick-start-guide/src/main/xslt/create-topic-pdf.xslt index 7d0714f..37c4a98 100644 --- a/cityehr-quick-start-guide/src/main/xslt/create-topic-pdf.xslt +++ b/cityehr-quick-start-guide/src/main/xslt/create-topic-pdf.xslt @@ -75,7 +75,7 @@ - +