diff --git a/cityehr-quick-start-guide/src/main/lwdita/quickstart-guide-modular/exporting-patient-data-from-cityehr.dita b/cityehr-quick-start-guide/src/main/lwdita/quickstart-guide-modular/exporting-patient-data-from-cityehr.dita index 9c3e8e2..736e807 100644 --- a/cityehr-quick-start-guide/src/main/lwdita/quickstart-guide-modular/exporting-patient-data-from-cityehr.dita +++ b/cityehr-quick-start-guide/src/main/lwdita/quickstart-guide-modular/exporting-patient-data-from-cityehr.dita @@ -8,58 +8,55 @@ Exporting Data for an Individual Patient
  1. -

    The full record for an individual patient can be exported from the patient Events page. Click on a patient in Patient Search for which you would like to export their record.

    +

    The full record for an individual patient can be exported from the patient Events page. Click on a patient in Patient Search for whom you would like to export their record.

    Selecting a Patient for Record Export

  2. -

    Navigate from the Summaries page to the Events page.

    +

    Navigate from the Summaries page to the Events page.

    Navigating to Patient Events Page

  3. -

    Select the Event you would like to export.

    +

    Select the event you would like to export.

    Selecting Patient Event to Export

  4. -

    Click the Export Record icon to export the Individual Patient Data.

    +

    Click the Export Record icon to export the individual patient data.

    Selecting Patient Event to Export

Exporting Data for a Cohort of Patients -

Data can be exported in various formats for patient cohorts that have been formed as a - result of cohort searches.

+

Data can be exported in various formats for patient cohorts created through cohort searches.

  1. -

    Navigate to Administration Screen in the Purple Dashboard.

    +

    Navigate to the Administration screen in the Purple system navigation.

  2. -

    Navigate to Cohort Searches in Menu on the Left of the screen and then click - “Manage Cohort Searches”.

    +

    Navigate to Cohort Searches in the menu on the left side of the screen, and then click Manage Cohort Searches.

    Manage Cohort Searches Page

  3. -

    You will be able to see your saved cohort searches in the main display screen.

    +

    View your saved cohort searches in the main display screen.

  4. -

    Click the box next to the Cohort Search you wish to export.

    +

    Select the box next to the cohort search you wish to export.

    Selecting Desired Cohort Search for Export

  5. -

    Now click the “Export” button that will appear at the top right of your screen.

    +

    Click the Export button that appears at the top right of your screen.

    Exporting Desired Cohort Search

  6. -

    A dialogue box will appear. You can save your Exported File or open with a Default Application

    +

    A dialogue box will appear. Save your exported file or open it with a default application.

    Cohort Export Dialogue Box

  7. -

    For this example, we will open with Microsoft Edge.

    +

    For this example, open the file with Microsoft Edge.

    Extracting the Exported Cohort File’s XML Contents

  8. -

    A dialogue box will appear that allows you to extract the xml contents. Extract the - contents then a new window will open with the xml of the exported data

    +

    Extract the XML contents, and a new window will open displaying the XML of the exported data.

    Window displaying extracted cohort XML file

@@ -68,22 +65,22 @@ Export Data Sets
  1. -

    Navigate to Administration Screen in the Purple Dashboard.

    +

    Navigate to the Administration screen in the Purple system navigation.

  2. -

    Navigate to Export Data Sets in Menu on the Left of the screen.

    +

    Navigate to Export Data Sets in the menu on the left side of the screen.

    Manage Export Data Sets Page

  3. -

    Name your Data Set

    +

    Enter a name for your data set.

    Naming the Data Set

  4. -

    Select the Entries you want to add to your exported data set. They will appear on the column on the right. You can also filter the Entries by composition if you click the drop-down next to “Composition”.

    +

    Select the entries you want to add to your exported data set. These will appear in the column on the right. You can also filter entries by composition by using the drop-down menu next to Composition.

    Selecting Entries to Add to Exported Data Set

  5. -

    Click the save button at the top right of the display window.

    +

    Click the Save button at the top right of the display window.

diff --git a/cityehr-quick-start-guide/src/main/lwdita/quickstart-guide-modular/inspecting-the-xml-store.dita b/cityehr-quick-start-guide/src/main/lwdita/quickstart-guide-modular/inspecting-the-xml-store.dita index 9b19879..8f83884 100644 --- a/cityehr-quick-start-guide/src/main/lwdita/quickstart-guide-modular/inspecting-the-xml-store.dita +++ b/cityehr-quick-start-guide/src/main/lwdita/quickstart-guide-modular/inspecting-the-xml-store.dita @@ -2,103 +2,73 @@ Inspecting the XML Store - The native XML database used in cityEHR can be browsed using tools in the Admin page. - This can be useful for understanding how data are stored and can be used by - administrators to remove information from the database. The facility to remove data must be used with extreme caution, since it may invalidate - the overall structure of the xmlstore and/or compromise patient records. + The native XML database used in cityEHR can be browsed using tools in the Administration page. This functionality is useful for understanding how data is stored and can assist administrators in managing database contents. However, the facility to remove data must be used with extreme caution as it may invalidate the XML store's structure and/or compromise patient records.
Browsing Logical Databases -
    -
  1. -

    Open the Administration page and select ‘Browse Logical Databases’ within - ‘databases’ from the menu on the left hand side of the display screen (Figure 95). The logical database will show you all the databases as if they are part of one database. The physical database can show you different nodes within that database.

    -
  2. -
-

Browse Logical Database Page -

+

Open the Administration page and select Browse Logical Databases within Databases from the menu on the left-hand side of the display screen. The logical database will display all databases as if they are part of one database, whereas the physical database shows the different nodes within that database.

+

Browse Logical Database Page

Browsing Physical Databases -
    +
    1. -

      Open the Administration page and select Browse Physical Databases from the list - on the left hand side of the display screen.

      +

      Open the Administration page and select Browse Physical Databases from the menu on the left-hand side.

    2. -

      There are two separate databases that can be used for the root of the browse:

      -

      XML store — holds users and patient records for all installed applications

      -

      Audit log — holds audit data for all users

      +

      Two separate databases are available as the root for browsing:

      +
        +
      • XML Store — stores users and patient records for all installed applications.

      • +
      • Audit Log — stores audit data for all users.

      • +
    3. -

      Click on the database store you would like to browse. We will select xmlstore for this example.

      +

      Select the database store you wish to browse. For this example, select xmlstore.

      Browse Physical Database Page

    4. -

      The top level of the xmlstore database has collections for applications, systems, and - users. Any cityEHR installation can support multiple applications and a single set of - users each of whom has access to one or more of the applications.

      +

      The top level of the xmlstore database contains collections for Applications, Systems, and Users. Any cityEHR installation can support multiple applications and a single set of users, each of whom has access to one or more applications.

      browse Physical Database "xmlstore" Page

    5. -

      Click on the users link and you will see a list of all users registered - with cityEHR. If you are following these instructions for the first time then - there will only be the default admin user and any that you imported or - created in the steps above.

      +

      Click on the users link to view a list of all registered users. Initially, this will include only the default admin user and any others you imported or created previously.

    6. -

      Click on the link for admin and the link credentials should be - displayed; click on that. Now click on the binoculars icon at the top right of - the viewing panel.

      +

      Click on the admin link, then on credentials. Click the binoculars icon at the top right of the viewing panel.

      Viewing "xmlstore" Page Credentials

    7. -

      You should now see an XML document in a new dialogue window on your screen. The - XML document contains the details for that user.

      +

      An XML document containing the user details (users.xml) will appear in a new dialogue window.

      XML Document of User Details

    8. -

      You can see the same XML for the user element that was contained in the users.xml file.

      -
    9. -
    10. -

      You can use the download the XML to view it in a notepad format.

      +

      You can download the XML to view it in a text editor.

    11. -

      Now return to the top level of the xmlstore by clicking the back button that is - located just to the right of the database selection drop down (don't confuse - this with pressing the back button in your web browser). See Figure 100 -

      +

      Return to the top level of the xmlstore by clicking the back button located next to the database selection drop-down + (not the browser's back button).

      Returning "xmlstore" Top Level by Clicking the Back Button

    12. -

      Click on the applications link, then the link for ISO-13606-EHR_Extract-cityEHR. -

      +

      Click on the applications link, then the link for ISO-13606-EHR_Extract-cityEHR.

    13. -

      This should now show the top level collections for the default cityEHR application.

      -

      Top Level Collections for the Default cityEHR Application

      +

      This displays the top-level collections for the default cityEHR application.

      +

      Top-Level Collections for the Default cityEHR Application

    14. -

      Click on the records link and you will now see a list of all patients with a - record stored for this application.

      +

      Click on the records link to see a list of patients with stored records for this application.

    15. -

      Click on the link for a patient and you will see the list of timestamped - compositions (XML documents in HL7 CDA format) that represent the events stored - in that patient's record.

      +

      Click on a patient's link to view a list of timestamped compositions (XML documents in HL7 CDA format) representing the events stored in their record.

      Patient Timestamped Compositions

    16. -

      Click on one of the timestamps and then click on the binoculars and you should - now see an HL7 CDA document for that event in a dialogue box on your screen.

      +

      Click on a timestamp, then on the binoculars icon to view an HL7 CDA document for the selected event.

      HL7 CDA Document for Selected Event

    17. -

      You can continue exploring the database from the ISO-13606-EHR_Extract-cityEHR - collection, looking at the contents stored for the information Model (these are - the OWL XML files that represent the models you imported) and the - system Configuration which holds the templates for new forms, letters, etc as - well as the full data dictionary for the application.

      +

      Continue exploring the database, such as the ISO-13606-EHR_Extract-cityEHR collection, to view contents stored for the information model (OWL XML files) and the system configuration (templates for forms, letters, and data dictionary).

diff --git a/cityehr-quick-start-guide/src/main/lwdita/quickstart-guide-modular/manipulating-the-information-model-as-an-ontology.dita b/cityehr-quick-start-guide/src/main/lwdita/quickstart-guide-modular/manipulating-the-information-model-as-an-ontology.dita index 9cbd521..1c7b709 100644 --- a/cityehr-quick-start-guide/src/main/lwdita/quickstart-guide-modular/manipulating-the-information-model-as-an-ontology.dita +++ b/cityehr-quick-start-guide/src/main/lwdita/quickstart-guide-modular/manipulating-the-information-model-as-an-ontology.dita @@ -2,84 +2,77 @@ Manipulating the Information Model as an Ontology - + This topic guides users through browsing, exporting, editing, and importing ontology-based information models in cityEHR using Protege.
Browse the Ontology in cityEHR -

Move to the Administration screen by pressing the button in the top right corner of the - screen. Then, move to Information Model in the Menu on the Left of the Screen. You - should land on “Manage Information Model”. You will see a summary of the information - models loaded for this installation (if not, press the selection to Manage Information - Model in the left hand menu).

-

Base Manage Information Model screen -

-

In the selection for Information Model, find the model for Specialty - cityEHR Feature - Demo. This is the model that was driving the interaction with the cityEHR that you have - just encountered.

-

Selecting cityEHR Feature Demo information model -

-

The model is loaded to cityEHR as an ontology which you can browse by selecting “Feature - Demo” from the Information Model drop down shown below. You can then expand the ontology by clicking the + sign. See image below.

-

Changing information model and viewing ontology -

-

You can browse through the ontology by expanding the tree controls - you should see the - Folders, Views, Forms, Sections and Entries for the screens you have already worked - with. You can select any of the loaded models and browse either as ISO-13606, data - dictionary contents, class hierarchies and class nodes, depending on the type of the - model (specialty or class hierarchy).

-

+
    +
  1. +

    Move to the Administration screen by pressing the button in the top right corner of the screen. Then, move to Information Model in the Menu on the Left of the Screen. You should land on “Manage Information Model”. You will see a summary of the information models loaded for this installation (if not, press the selection to Manage Information Model in the left hand menu).

    +
  2. +
  3. +

    Base Manage Information Model screen

    +
  4. +
  5. +

    In the selection for Information Model, find the model for Specialty - cityEHR Feature Demo. This is the model that was driving the interaction with the cityEHR that you have just encountered.

    +

    Selecting cityEHR Feature Demo information model

    +
  6. +
  7. +

    The model is loaded to cityEHR as an ontology which you can browse by selecting “Feature Demo” from the Information Model drop down shown below. You can then expand the ontology by clicking the + sign. See image below.

    +

    Changing information model and viewing ontology

    +
  8. +
  9. +

    You can browse through the ontology by expanding the tree controls - you should see the Folders, Views, Forms, Sections and Entries for the screens you have already worked with. You can select any of the loaded models and browse either as ISO-13606, data dictionary contents, class hierarchies and class nodes, depending on the type of the model (specialty or class hierarchy).

    +
  10. +
Export the Ontology and Open in Protege
    -
  1. You can now export the ontology by pressing the Export button in the top right - this - will take the ontology from the cityEHR database and return it to the browser as a zip - file. Click on the button that says OWL.

    +
  2. +

    Export the ontology by clicking the Export button at the top-right. Select OWL to download the ontology as a zip file.

    Exporting Ontology models

  3. -

    Save the file somewhere on your system, rename it to use a .zip extension and unzip to obtain the ontology (OWL/XML) file. If all has worked correctly, this file will be called export.xml. It is indeed an XML file, but it is in the OWL/XML vocabulary, so its useful to rename it to have a .owl extension.

    +

    Save the file on your system. Rename it to use a .zip extension and unzip it to obtain the ontology (an OWL/XML file). Rename the file to use a .owl extension for easier compatibility with Protege.

    Renaming export file pop-up

  4. -

    You can now open this ontology with Protege. Start Protege and select to open an existing ontology, navigate to the unzipped ontology from above and it should open. If you have renamed your file with a .owl extension then you should also be able to open it in Protege by double clicking on it.

    +

    Open the ontology in Protege. Start Protege, select Open an existing ontology, navigate to the unzipped file, and open it. You can also double-click the file if it has a .owl extension.

  5. -

    Select the Classes tab to take a look at the class hierarchy for the cityEHR - architecture and then the Individuals tab to see the specific instantiation for the - Feature Demo information model.

    +

    Use the Classes tab to view the class hierarchy and the Individuals tab for specific instantiations of the Feature Demo model.

  6. -

    You will see classes that correspond to items in the ISO-13606 and HL7 CDA models, - together with some additional classes that are specific to the cityEHR.

    +

    Explore classes corresponding to ISO-13606, HL7 CDA, and cityEHR-specific components.

  7. -

    Select the Object Properties tab at the top of the window and expand the Top Object - Property to show a list of all the object properties available in the cityEHR - architecture. These are split into two sets, with names starting 'has' or 'is' - each - named pair being the inverse of each other.

    +

    Under the Object Properties tab, expand Top Object Property to view all object properties in cityEHR. These are split into two sets, with names starting 'has' or 'is' - each named pair being the inverse of each other.

  8. -

    Now select the Data Properties tab at the top of the window and expand the Top Data - Property to show a list of all the data properties available in cityEHR

    +

    Similarly, use the Data Properties tab to view all data properties available in the architecture.

Edit the Ontology -

In Protege, try adding a new section to one of the forms and some new entries to the - section. Save the file using Save As (in case you have made a mistake).

-

Your workshop instructor will guide you through these edits.

-

+

In Protege, try adding a new section to a form or new entries to an existing section. Save your changes using Save As to preserve the original file in case of errors.

+

Note: Ensure you follow your workshop instructor's guidance to prevent issues in the ontology structure.

Load the Model to cityEHR -

Return to the cityEHR Admin page and select Import Information Model form the left hand - menu. Browse to you OWL/XML model and press Upload. Once the file has been uploaded you - can then press the Import button. This will take a few seconds before displaying a - summary of the model it has imported. If there are errors these will be reported and the model will not be loaded.

-

Once the model has loaded, return to the Patient Search screen, search for and select a - patient then visit the form you changed in the model to see the changes.

+ +
    +
  1. +

    Return to the cityEHR Admin page and select Import Information Model from the left-hand menu. Browse to your OWL/XML file, upload it, and then click Import.

    +
  2. +
  3. +

    Once the import completes, a summary of the loaded model will appear. If errors are found, the model will not be loaded, and the errors will be reported.

    +
  4. +
  5. +

    After a successful import, return to the Patient Search screen. Select a patient and navigate to the updated form to verify the changes.

    +
  6. +