Version:1.0.0-SNAPSHOT

Revision:27th March 2025

Quick Start Guide

Download PDF version

Table of Contents

  1. 1. Introduction
  2. 2. Verifying the installation
    1. 2.1. Log On
    2. 2.2. Reloading the Default Application
    3. 2.3. Running in Debug Mode
    4. 2.4. Session Time Out
    5. 2.5. Download User Resources
  3. 3. Exploring the Default cityEHR Application
    1. 3.1. Registering a New Patient
    2. 3.2. Entering Patient Data
    3. 3.3. Finding Patients
  4. 4. Creating Test Patients
  5. 5. Viewing the Patient Record
    1. 5.1. Summary View and Charting
    2. 5.2. Viewing the Longitudinal Record
    3. 5.3. Annotations and Notifications
  6. 6. Cohort Search
    1. 6.1. Demographics
    2. 6.2. Administrative Data
    3. 6.3. Observations
    4. 6.4. Combining Cohorts
  7. 7. Exporting Patient Data from cityEHR
    1. 7.1. Exporting Data for an Individual Patient
    2. 7.2. Exporting Data for a Cohort of Patients
    3. 7.3. Export Data Sets
  8. 8. Inspecting the XML Store
    1. 8.1. Browsing Logical Databases
    2. 8.2. Browsing Physical Databases
  9. 9. Manipulating the Information Model as an Ontology
    1. 9.1. Browse the Ontology in cityEHR
    2. 9.2. Export the Ontology and Open in Protege
    3. 9.3. Edit the Ontology
    4. 9.4. Load the Model to cityEHR
  10. 10. Manipulating the Information Model as a Spreadsheet
  11. 11. Configuring a Runtime Application
    1. 11.1. Creating Your Own cityEHR Application – New Application
    2. 11.2. Creating a Shipped Application
  12. 12. Creating an Information Model
  13. 13. Managing Information Directories
    1. 13.1. Element Directories
    2. 13.2. Entry Directories
    3. 13.3. Importing Directories
    4. 13.4. Directory Look Up Using a Web Service
  14. 14. Access Control - documentation coming soon!
    1. 14.1. Setting Up User Roles
    2. 14.2. Assigning Roles for a User
    3. 14.3. Role-based Access Control to Functions
    4. 14.4. Restricting Access to Care Team Patients
  15. 15. Care Pathways – documentation coming soon!
    1. 15.1. Health Lifestyle Pathway
    2. 15.2. Using Sub-Pathways
    3. 15.3. Pathways with Repeating Loops
  16. 16. Clinical Correspondence
    1. 16.1. Creating a Letter Template
    2. 16.2. Importing and Associating a Template
    3. 16.3. Using a Template with a Letter
  17. 17. Interactive Image Maps
    1. 17.1. Linking to a Simple Entry
    2. 17.2. Linking to a Multiple Entry
    3. 17.3. Creating a New Image Map
  18. 18. Creating Language Variants
  19. 19. Using the cityEHR API
    1. 19.1. Enabling API Access
    2. 19.2. Using the cityEHR API