Documentation

.. figure::

http://code.osehra.org/content/named/SHA1/b0c675f8-OSEHRALogo_2018_Tiny.png :align: center

OSEHRA VistA Documentation

This page is the main page to find documentation regarding the capabilities of the OSEHRA VistA source tree. This source tree contains a wide range of utilities that are useful for generating or maintaining a VistA instance or programs related to one.

Contents

• OSEHRA VistA Documentation
  • How to Contribute
  • Build CPRS
  • Automatic Patching
  • Instructions for Establishing and Testing a VistA Installation
    • Caché
    • GT.M
  • Generating the OSEHRA VistA-M Dox Pages
  • Routine changes to the VistA Environment
  • Automated Virtual Machine (VM) creation and VistA installation
  • OSEHRA Technical Journal
  • Troubleshooting
  • Standards

How to Contribute

The OSEHRA VistA repository uses a Gerrit Review instance to accept incoming changes from the community. For instructions on setting up the and an example workflow, see the Contributor Git Instructions

Build CPRS

To build the Computerized Patient Record System (CPRS) from the OSEHRA VistA source tree, see the following file for instructions:

• BUILD-Delphi

Automatic Patching

To learn more about, and utilize, the automatic patching of a VistA instance from the files in the VistA source tree, follow the instructions in:

• PatchSequenceApply

Instructions for Establishing and Testing a VistA Installation

These pages describe the steps required to obtain the OSEHRA open source VistA codebase from the OSEHRA code repository, establish a working test environment, execute the tests, and view the results on the OSEHRA Software Quality Dashboard.

The first section consists of instructions on acquiring the source code and other auxiliary programs:

• ObtainingandInstallAuxPrograms
• ObtainingTestingCode

If the VistA instance to be generate is going to be imported from the OSEHRA VistA-M repository, see the following file for instructions on obtaining and preparing the M code for import:

• ObtainingVistAMCode

For the next sections, follow the instructions based upon which type of MUMPS database will be utilized for the VistA installation:

Caché

If necessary, OSEHRA has compiled a set of instructions on how to install the Caché instance:

• InstallCache

There are two methods available to import the VistA-M code into the Caché environment.

To install a downloaded CACHE.DAT file as the source of the VistA MUMPS code and follow the instructions here:

• InstallCacheDat

Alternatively, it is possible to import the MUMPS code from the OSEHRA VistA-M Repository into a Caché instance. To use OSEHRA's automated import and configuration scripts, see:

• AutomatedVistAConfiguration

Instructions for the manual import process are found here:

• ImportCache

Instructions for additional configuration of the Caché environment can be found here:

• ConfigureCache

GT.M

For instructions on the installation of a FIS-GT.M environment, see

• InstallGTM

To use OSEHRA's automated import and configuration scripts to import the OSEHRA VistA-M code into the GT.M environment, see:

• AutomatedVistAConfiguration

Instructions for the manual import process are found here:

• ImportGTM

The last sections are common to both types of systems and utilize the OSEHRA Testing Harness:

• SetupTestingEnvironment
• RunningandUploadingTests

For information on how to add to the OSEHRA Testing Harness, see:

• AddingTests

Once the tests have been run and submitted, the results can be seen on the OSEHRA Dashboard, for more information see:

• ReviewingResults

For initialization and setup of an imported VistA instance (general setup and adding a user) without using the OSEHRA Utilities, see:

• Initialization

Generating the OSEHRA VistA-M Dox Pages

The OSEHRA VistA source tree is also used in the generation of the Dox pages which can be found at code.osehra.org/dox. For instructions on how to set up and execute the steps necessary to generate the HTML files, see Generate ViViaN and DOX.

Routine changes to the VistA Environment

The OSEHRA VistA framework makes some modifications to the installed VistA system when using the TEST_VISTA_FRESH and TEST_VISTA_SETUP options. For information about the changes and why they were made, see testingChanges

Automated Virtual Machine (VM) creation and VistA installation

Using the power of Vagrant there is a Vagrantfile in the Scripts/Install/Ubuntu directory that can be used to create a VM with VistA installed and runs a selection of unit tests. This type of VM creation is designed with DevOps in mind, but can be useful to try VistA out for the first time, demo system, among many other uses. However, DO NOT use this VM for production purposes!

• Overview

For more information regarding using Vagrant with cloud providers:

• Amazon Web Services
• Rackspace

OSEHRA Technical Journal

For information on the OSEHRA Certification Process or how to submit your work to the OSEHRA Technical Journal, see:

• OSEHRA Certification Standards
• Submitting to the OTJ
• Reviewing Submissions in the OSEHRA Technical Journal

Troubleshooting

To report a problem or see potential solutions visit the Troubleshooting Page

Standards

OSEHRA mantains the Standards and Conventions for software in the Standards directory and includes:

• M Standards and Conventions