Skip to content

Commit

Permalink
Content rewriting
Browse files Browse the repository at this point in the history 
Major content edits and updating
  • Loading branch information
@JennnRamirez
JennnRamirez committed Nov 26, 2024
1 parent a2ebc51 commit 7975ecf
Show file tree
Hide file tree
Showing 3 changed files with 85 additions and 125 deletions.
39 changes: 18 additions & 21 deletions ...t-guide/src/main/lwdita/quickstart-guide-modular/exporting-patient-data-from-cityehr.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,58 +8,55 @@
<title>Exporting Data for an Individual Patient</title>
<ol>
<li>
<p>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. </p>
<p>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.</p>
<p><image href="images/patient-search-select.png" format="image/png"><alt>Selecting a Patient for Record Export</alt></image></p>
</li>
<li>
<p>Navigate from the Summaries page to the Events page. </p>
<p>Navigate from the <b>Summaries</b> page to the <b>Events</b> page.</p>
<p><image href="images/events-view-select.png" format="image/png"><alt>Navigating to Patient Events Page</alt></image></p>
</li>
<li>
<p>Select the Event you would like to export. </p>
<p>Select the event you would like to export.</p>
<p><image href="images/events-select.png" format="image/png"><alt>Selecting Patient Event to Export</alt></image></p>
</li>
<li>
<p>Click the Export Record icon to export the Individual Patient Data.</p>
<p>Click the <b>Export Record</b> icon to export the individual patient data.</p>
<p><image href="images/events-lifestyle-export.png" format="image/png"><alt>Selecting Patient Event to Export</alt></image></p>
</li>
</ol>
</section>
<section id="exporting-data-for-a-cohort-of-patients">
<title>Exporting Data for a Cohort of Patients</title>
<p>Data can be exported in various formats for patient cohorts that have been formed as a
result of cohort searches. </p>
<p>Data can be exported in various formats for patient cohorts created through cohort searches.</p>
<ol>
<li>
<p>Navigate to Administration Screen in the Purple Dashboard. </p>
<p>Navigate to the <b>Administration</b> screen in the Purple system navigation.</p>
</li>
<li>
<p>Navigate to Cohort Searches in Menu on the Left of the screen and then click
“Manage Cohort Searches”. </p>
<p>Navigate to <b>Cohort Searches</b> in the menu on the left side of the screen, and then click <b>Manage Cohort Searches</b>.</p>
<p><image href="images/admin-manage-cohort-search.png" format="image/png"><alt>Manage Cohort Searches Page</alt></image></p>
</li>
<li>
<p>You will be able to see your saved cohort searches in the main display screen.</p>
<p>View your saved cohort searches in the main display screen.</p>
</li>
<li>
<p>Click the box next to the Cohort Search you wish to export.</p>
<p>Select the box next to the cohort search you wish to export.</p>
<p><image href="images/admin-cohort-search-select.png" format="image/png"><alt>Selecting Desired Cohort Search for Export</alt></image></p>
</li>
<li>
<p>Now click the “Export” button that will appear at the top right of your screen.</p>
<p>Click the <b>Export</b> button that appears at the top right of your screen.</p>
<p><image href="images/admin-cohort-search-export.png" format="image/png"><alt>Exporting Desired Cohort Search</alt></image></p>
</li>
<li>
<p>A dialogue box will appear. You can save your Exported File or open with a Default Application </p>
<p>A dialogue box will appear. Save your exported file or open it with a default application.</p>
<p><image href="images/admin-cohort-search-dialogue.png" format="image/png"><alt>Cohort Export Dialogue Box</alt></image></p>
</li>
<li>
<p>For this example, we will open with Microsoft Edge.</p>
<p>For this example, open the file with <b>Microsoft Edge</b>.</p>
<p><image href="images/admin-cohort-search-extract-export.png" format="image/png"><alt>Extracting the Exported Cohort File’s XML Contents</alt></image></p>
</li>
<li>
<p>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 </p>
<p>Extract the XML contents, and a new window will open displaying the XML of the exported data.</p>
<p><image href="images/extracted-cohort-data.png" format="image/png"><alt>Window displaying extracted cohort XML file</alt></image></p>
</li>
</ol>
Expand All @@ -68,22 +65,22 @@
<title>Export Data Sets</title>
<ol>
<li>
<p>Navigate to Administration Screen in the Purple Dashboard.</p>
<p>Navigate to the <b>Administration</b> screen in the Purple system navigation.</p>
</li>
<li>
<p>Navigate to Export Data Sets in Menu on the Left of the screen.</p>
<p>Navigate to <b>Export Data Sets</b> in the menu on the left side of the screen.</p>
<p><image href="images/admin-manage-export-data.png" format="image/png"><alt>Manage Export Data Sets Page</alt></image></p>
</li>
<li>
<p>Name your Data Set</p>
<p>Enter a name for your data set.</p>
<p><image href="images/admin-manage-export-data-naming.png" format="image/png"><alt>Naming the Data Set</alt></image></p>
</li>
<li>
<p>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”.</p>
<p>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 <b>Composition</b>.</p>
<p><image href="images/admin-manage-export-data-select-entries.png" format="image/png"><alt>Selecting Entries to Add to Exported Data Set</alt></image></p>
</li>
<li>
<p>Click the save button at the top right of the display window.</p>
<p>Click the <b>Save</b> button at the top right of the display window.</p>
</li>
</ol>
</section>
Expand Down
80 changes: 25 additions & 55 deletions ...-quick-start-guide/src/main/lwdita/quickstart-guide-modular/inspecting-the-xml-store.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,103 +2,73 @@
<!DOCTYPE topic PUBLIC "-//OASIS//DTD LIGHTWEIGHT DITA Topic//EN" "topic.dtd">
<topic id="inspecting-the-xml-store">
<title>Inspecting the XML Store</title>
<shortdesc>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.</shortdesc>
<shortdesc> 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.</shortdesc>
<body>
<section id="browsing-logical-databases">
<title>Browsing Logical Databases</title>
<ol id="ol_ovr_14v_vcc">
<li>
<p>Open the Administration page and select ‘Browse Logical Databases’ within
‘databases’ from the menu on the left hand side of the display screen <i> (Figure 95)</i>. 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. </p>
</li>
</ol>
<p><image href="images/admin-browse-logical-database.png" format="image/png"><alt>Browse Logical Database Page</alt></image>
</p>
<p>Open the <b>Administration</b> page and select <b>Browse Logical Databases</b> within <b>Databases</b> 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.</p>
<p><image href="images/admin-browse-logical-database.png" format="image/png"><alt>Browse Logical Database Page</alt></image></p>
</section>
<section id="browsing-physical-databases">
<title>Browsing Physical Databases</title>
<ol id="ol_rvr_14v_vcc">
<ol>
<li>
<p>Open the Administration page and select Browse Physical Databases from the list
on the left hand side of the display screen. </p>
<p>Open the <b>Administration</b> page and select <b>Browse Physical Databases</b> from the menu on the left-hand side.</p>
</li>
<li>
<p>There are two separate databases that can be used for the root of the browse:</p>
<p>XML store — holds users and patient records for all installed applications </p>
<p>Audit log — holds audit data for all users </p>
<p>Two separate databases are available as the root for browsing:</p>
<ul>
<li><p><b>XML Store</b> — stores users and patient records for all installed applications.</p></li>
<li><p><b>Audit Log</b> — stores audit data for all users.</p></li>
</ul>
</li>
<li>
<p>Click on the database store you would like to browse. We will select xmlstore for this example. </p>
<p>Select the database store you wish to browse. For this example, select <b>xmlstore</b>.</p>
<p><image href="images/admin-browse-physical-database.png" format="image/png"><alt>Browse Physical Database Page</alt></image></p>
</li>
<li>
<p>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. </p>
<p>The top level of the <b>xmlstore</b> database contains collections for <b>Applications</b>, <b>Systems</b>, and <b>Users</b>. Any cityEHR installation can support multiple applications and a single set of users, each of whom has access to one or more applications.</p>
<p><image href="images/admin-browse-physical-xmlstore.png" format="image/png"><alt>browse Physical Database "xmlstore" Page</alt></image></p>
</li>
<li>
<p>Click on the <i>users</i> 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 <i>admin</i> user and any that you imported or
created in the steps above. </p>
<p>Click on the <b>users</b> link to view a list of all registered users. Initially, this will include only the default <b>admin</b> user and any others you imported or created previously.</p>
</li>
<li>
<p>Click on the link for <i>admin</i> and the link <i>credentials</i> should be
displayed; click on that. Now click on the binoculars icon at the top right of
the viewing panel. </p>
<p>Click on the <b>admin</b> link, then on <b>credentials</b>. Click the binoculars icon at the top right of the viewing panel.</p>
<p><image href="images/view-xmlstore.png" format="image/png"><alt>Viewing "xmlstore" Page Credentials</alt></image></p>
</li>
<li>
<p>You should now see an XML document in a new dialogue window on your screen. The
XML document contains the details for that user. </p>
<p>An XML document containing the user details (<i>users.xml</i>) will appear in a new dialogue window.</p>
<p><image href="images/view-xmlstore-dialogue.png" format="image/png"><alt>XML Document of User Details</alt></image></p>
</li>
<li>
<p>You can see the same XML for the user element that was contained in the users.xml file. </p>
</li>
<li>
<p>You can use the download the XML to view it in a notepad format. </p>
<p>You can download the XML to view it in a text editor.</p>
</li>
<li>
<p>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 <i>Figure 100</i>
</p>
<p>Return to the top level of the <b>xmlstore</b> by clicking the back button located next to the database selection drop-down
(not the browser's back button).</p>
<p><image href="images/view-xmlstore-return-button.png" format="image/png"><alt>Returning "xmlstore" Top Level by Clicking the Back Button</alt></image></p>
</li>
<li>
<p>Click on the applications link, then the link for ISO-13606-EHR_Extract-cityEHR.
</p>
<p>Click on the <b>applications</b> link, then the link for <b>ISO-13606-EHR_Extract-cityEHR</b>.</p>
</li>
<li>
<p>This should now show the top level collections for the default cityEHR application. </p>
<p><image href="images/admin-browse-physical-toplevel.png" format="image/png"><alt>Top Level Collections for the Default cityEHR Application</alt></image></p>
<p>This displays the top-level collections for the default cityEHR application.</p>
<p><image href="images/admin-browse-physical-toplevel.png" format="image/png"><alt>Top-Level Collections for the Default cityEHR Application</alt></image></p>
</li>
<li>
<p>Click on the records link and you will now see a list of all patients with a
record stored for this application. </p>
<p>Click on the <b>records</b> link to see a list of patients with stored records for this application.</p>
</li>
<li>
<p>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. </p>
<p>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.</p>
<p><image href="images/admin-browse-physical-timestamp.png" format="image/png"><alt>Patient Timestamped Compositions</alt></image></p>
</li>
<li>
<p> 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.</p>
<p>Click on a timestamp, then on the binoculars icon to view an HL7 CDA document for the selected event.</p>
<p><image href="images/admin-browse-physical-timestamp-xml.png" format="image/png"><alt>HL7 CDA Document for Selected Event</alt></image></p>
</li>
<li>
<p>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. </p>
<p>Continue exploring the database, such as the <b>ISO-13606-EHR_Extract-cityEHR</b> collection, to view contents stored for the information model (OWL XML files) and the system configuration (templates for forms, letters, and data dictionary).</p>
</li>
</ol>
</section>
Expand Down
Loading

0 comments on commit 7975ecf

Please sign in to comment.