Observational Health Data Sciences and Informatics (OHDSI) WebAPI

General Information

Technologies must be operated and maintained in accordance with Federal and Department security and privacy policies and guidelines. More information on the proper use of the TRM can be found on the TRM Proper Use Tab/Section.

Website:	Go to site
Description:	Observational Health Data Sciences and Informatics (OHDSI) Web Application Programming Interface (API) is a Representation State Transfer (REST)ful service layer that provides access to data and method execution. OHDSI WebAPI provides a set of web services that are used by the OHDSI applications and provides a general purpose API for access to OHDSI standard information. Additionally, this technology provides access to the following RESTful services: Standardized Vocabularies, Common Data Model, LAERTES Evidence Knowledge Base, Cohort Definition/Analysis, Study Feasibility, and Therapy Path Reporting. OHDSI WebAPI is compatible with Oracle Database, Microsoft Structured Query Language (SQL) Server, and PostgreSQL databases.
Technology/Standard Usage Requirements:	Users must ensure their use of this technology/standard is consistent with VA policies and standards, including, but not limited to, VA Handbooks 6102 and 6500; VA Directives 6004, 6513, and 6517; and National Institute of Standards and Technology (NIST) standards, including Federal Information Processing Standards (FIPS). Users must ensure sensitive data is properly protected in compliance with all VA regulations. Prior to use of this technology, users should check with their supervisor, Information Security Officer (ISO), Facility Chief Information Officer (CIO), or local Office of Information and Technology (OI&T) representative to ensure that all actions are consistent with current VA policies and procedures prior to implementation.
Section 508 Information:	This technology has not been assessed by the Section 508 Office. The Implementer of this technology has the responsibility to ensure the version deployed is 508-compliant. Section 508 compliance may be reviewed by the Section 508 Office and appropriate remedial action required if necessary. For additional information or assistance regarding Section 508, please contact the Section 508 Office at Section508@va.gov.
Decision:	View Decisions

Decision Source:	TRM Mgmt Group
Decision Process:	One-VA TRM v22.8
Decision Date:	08/05/2022 at 13:40:30 UTC
Introduced By:	TRM Request
Vendor Name:	Observational Health Data Sciences & Informatics (OHDSI)

Vendor Release Information

The Vendor Release table provides the known releases for the TRM Technology, obtained from the vendor (or from the release source).

Version	Release Date	Vendor End of Life Date	Vendor Desupport Date
1.4.x	09/20/2016
2.2.x	10/11/2017
2.5.x	08/28/2018
2.7.x	01/23/2020
2.11.x	06/30/2022

Current Decision Matrix (08/02/2022)

Users must ensure their use of this technology/standard is consistent with VA policies and standards, including, but not limited to, VA Handbooks 6102 and 6500; VA Directives 6004, 6513, and 6517; and National Institute of Standards and Technology (NIST) standards, including Federal Information Processing Standards (FIPS). Users must ensure sensitive data is properly protected in compliance with all VA regulations. Prior to use of this technology, users should check with their supervisor, Information Security Officer (ISO), Facility Chief Information Officer (CIO), or local Office of Information and Technology (OI&T) representative to ensure that all actions are consistent with current VA policies and procedures prior to implementation.

The VA Decision Matrix displays the current and future VA IT position regarding different releases of a TRM entry. These decisions are based upon the best information available as of the most current date. The consumer of this information has the responsibility to consult the organizations responsible for the desktop, testing, and/or production environments to ensure that the target version of the technology will be supported. Any major.minor version that is not listed in the VA Decision Matrix is considered unapproved for use.

Legend:

White	Approved: The technology/standard has been approved for use.
Yellow	Approved w/Constraints: The technology/standard can be used within the specified constraints located below the decision matrix in the footnote[1] and on the General tab.
Gray	Unapproved: This technology or standard can be used only if a POA&M review is conducted and signed by the Authorizing Official Designated Representative (AODR) as designated by the Authorizing Official (AO) or designee and based upon a recommendation from the POA&M Compliance Enforcement, has been granted to the project team or organization that wishes to use the technology.
Orange	Divest: VA has decided to divest itself on the use of the technology/standard. As a result, all projects currently utilizing the technology/standard must plan to eliminate their use of the technology/standard. Additional information on when the entry is projected to become unapproved may be found on the Decision tab for the specific entry.
Black	Prohibited: The technology/standard is not (currently) permitted to be used under any circumstances.
Blue	Planning/Evaluation Constraint:The period of time this technology is currently being evaluated, reviewed, and tested in controlled environments. Use of this technology is strictly controlled and not available for use within the general population. If a customer would like to use this technology, please work with your local or Regional OI&T office and contact the appropriate evaluation office displayed in the notes below the decision matrix. The Local or Regional OI&T office should submit an inquiry to the TRM if they require further assistance or if the evaluating office is not listed in the notes below.

Release/Version Information:

VA decisions for specific versions may include a ‘.x’ wildcard, which denotes a decision that pertains to a range of multiple versions.

For example, a technology approved with a decision for 7.x would cover any version of 7.(Anything) - 7.(Anything). However, a 7.4.x decision would cover any version of 7.4.(Anything), but would not cover any version of 7.5.x or 7.6.x on the TRM.

VA decisions for specific versions may include ‘+’ symbols; which denotes that the decision for the version specified also includes versions greater than what is specified but is not to exceed or affect previous decimal places.

For example, a technology approved with a decision for 12.6.4+ would cover any version that is greater than 12.6.4, but would not exceed the .6 decimal ie: 12.6.401 is ok, 12.6.5 is ok, 12.6.9 is ok, however 12.7.0 or 13.0 is not.

<Past

CY2022

CY2023

CY2024

Future>

Release

Q1

Q2

Q3

Q4

Q1

Q2

Q3

Q4

Q1

Q2

Q3

Q4

1.4.x

Unapproved

2.2.x

Unapproved

2.5.x

Unapproved

2.7.x

Unapproved

2.11.x

Unapproved

Approved w/Constraints
[2, 4, 7, 8, 9]

Approved w/Constraints
[2, 7, 9, 10, 11]

Approved w/Constraints
[2, 7, 9, 11, 12]

Decision Constraints


[1]	Per the May 5th, 2015 memorandum from the VA Chief Information Security Officer (CISO) FIPS 140-2 Validate Full Disk Encryption (FOE) for Data at Rest in Database Management Systems (DBMS) and in accordance with Federal requirements and VA policy, database management must use Federal Information Processing Standards (FIPS) 140-2 compliant encryption to protect the confidentiality and integrity of VA information at rest at the application level. If FIPS 140-2 encryption at the application level is not technically possible, FIPS 140-2 compliant full disk encryption (FOE) must be implemented on the hard drive where the DBMS resides. Appropriate access enforcement and physical security control must also be implemented. All instances of deployment using this technology should be reviewed to ensure compliance with VA Handbook 6500 and National Institute of Standards and Technology (NIST) standards. It is the responsibility of the system owner to work with the local CIO (or designee) and Information Security Officer (ISO) to ensure that a compliant DBMS technology is selected and that if needed, mitigating controls are in place and documented in a System Security Plan (SSP).

[2]	Technology must remain patched and operated in accordance with Federal and Department security policies and guidelines in order to mitigate known and future security vulnerabilities.

[3]	In cases where the technology is used for external connections, a full Enterprise Security Change Control Board (ESCCB) review is required in accordance VA Directive 6004 , VA Directive 6517, and VA Directive 6513. The local ISO can advise on the ESCCB review process.

[4]	Users should check with their supervisor, Information Security Office (ISO) or local OIT representative for permission to download and use this software. Downloaded software must always be scanned for viruses prior to installation to prevent adware or malware. Freeware may only be downloaded directly from the primary site that the creator of the software has advertised for public download and user or development community engagement. Users should note, any attempt by the installation process to install any additional, unrelated software is not approved and the user should take the proper steps to decline those installations.

[5]	Per the May 5th, 2015 memorandum from the VA Chief Information Security Officer (CISO) FIPS 140-2 Validate Full Disk Encryption (FOE) for Data at Rest in Database Management Systems (DBMS) and in accordance with Federal requirements and VA policy, database management must use Federal Information Processing Standards (FIPS) 140-2 compliant encryption to protect the confidentiality and integrity of VA information at rest at the application level. If FIPS 140-2 encryption at the application level is not technically possible, FIPS 140-2 compliant full disk encryption (FOE) must be implemented on the hard drive where the DBMS resides. Appropriate access enforcement and physical security control must also be implemented. All instances of deployment using this technology should be reviewed to ensure compliance with VA Handbook 6500 and National Institute of Standards and Technology (NIST) standards. It is the responsibility of the system owner to work with the local CIO (or designee) and Information Security Officer (ISO) to ensure that a compliant DBMS technology is selected and that if needed, mitigating controls are in place and documented in a System Security Plan (SSP).

[6]	In cases where the technology is used for external connections, a full Enterprise Security Change Control Board (ESCCB) review is required in accordance VA Directive 6004 , VA Directive 6517, and VA Directive 6513. The local ISO can advise on the ESCCB review process.

[7]	Users must ensure that Oracle, Microsoft Structured Query Language (SQL) Server, Apache Tomcat and PostgreSQL are implemented with VA-approved baselines. (Refer to the ‘Category’ tab under ‘Runtime Dependencies’)

[8]	Veterans Affairs (VA) users must ensure VA sensitive data is properly protected in compliance with all VA regulations. All instances of deployment using this technology should be reviewed by the local ISO (Information Security Officer) to ensure compliance with VA Handbook 6500.

[9]	This product can be configured with a PostgreSQL Database, which currently has TRM constraints limiting its use to Red Hat Enterprise Linux (RHEL) only due to its many known security issues on other platforms. If PostgreSQL is selected for use with this product, these factors must be considered especially when an instance of this product will be considered a Moderate or High-Risk system. See PostgreSQL Database TRM entry for more details.

[10]	Veterans Affairs (VA) users must ensure VA sensitive data is properly protected in compliance with all VA regulations. All instances of deployment using this technology should be reviewed by the local ISSO (Information System Security Officer) to ensure compliance with VA Handbook 6500.

[11]	Users should check with their supervisor, Information System Security Officer (ISSO) or local OIT representative for permission to download and use this software. Downloaded software must always be scanned for viruses prior to installation to prevent adware or malware. Freeware may only be downloaded directly from the primary site that the creator of the software has advertised for public download and user or development community engagement. Users should note, any attempt by the installation process to install any additional, unrelated software is not approved and the user should take the proper steps to decline those installations.

[12]	Veterans Affairs (VA) users must ensure VA sensitive data is properly protected in compliance with all VA regulations. All instances of deployment using this technology should be reviewed by the local ISSO (Information System Security Officer) to ensure compliance with both VA Handbook 6500 and VA Directive 6500.

Note:

At the time of writing, version 2.11.1 is the most current version, released 06/30/2022.

References

The following reference(s) are associated with this entry:
Type	Name	Description
Other	Source Code	This site links to the source code repository for this product.
Vendor Provided*	Installation Guide	This links to the installation guide for OHDSI WebAPI.
*NOTE: Vendor provided information is subject to the accuracy of the manufacturer.

Technology Components

Note: This list may not be complete. No component, listed or unlisted, may be used outside of the technology in which it is released. The usage decision for a component is found in the Decision and Decision Constraints.
Name	Description
No components have been identified for this entry.

VA Categories View the VA Categorization Framework

Domain Area	Category	Customer Guidance	Category Locked By ELT Date
Information Management Technologies Data Management	Database Connectivity

Open Source

This entry is available as an open source technology.

Operating Systems Supported by the Technology

Windows Server - Approved w/Constraints

Technologies/Standards Relationships

Runtime Dependencies:

Comparable Technologies:

No comparable entries have been identified.

Companion Technologies/Supported Standards:

General Analysis

Adoption Benefits

This is a mature technology.
At the time of writing, no National Institute of Standards and Technology (NIST) vulnerabilities had been reported and no VA Cyber Security Operations Center (CSOC) bulletins had been issued for the latest versions of this technology.
This technology is available at no cost through open-source licensing and supports VA`s open source initiative.
This technology has a comprehensive set of documentation.
This technology may improve productivity for specific staff whose responsibilities include data integration and execution services.

Adoption Risks

This technology is available as freeware. If commercial support is not purchased, the product will be without clearly defined support options which may result in suboptimal enterprise level support.
This product can be configured with a PostgreSQL Database, which currently has TRM constraints limiting its use to Red Hat Enterprise Linux (RHEL) only due to its many known security issues on other platforms.
The potential exists to store Personally Identifiable Information (PII), Protected Health Information (PHI) and/or VA Sensitive data and proper security standards must be followed in these cases.
This technology has the ability to publish and store data in remote locations.
This technology can integrate with and alter database technologies.
Due to the rapid release schedule of this technology, the VA may be unable to update to the most recent patch and may require a deployment model requiring the use of specific versions.

Architectural Risks

This technology is not portable as it runs only on Windows platforms.

Inside VA

Budget and Performance

Inside the Media Room

National Observances

Special Events

VA Technical Reference Model v 24.7

General Information

Vendor Release Information

Current Decision Matrix (08/02/2022)

Decision Constraints

References

Technology Components

VA Categories View the VA Categorization Framework

Open Source

Operating Systems Supported by the Technology

Technologies/Standards Relationships

Runtime Dependencies:

Comparable Technologies:

Companion Technologies/Supported Standards:

General Analysis

Adoption Benefits

Adoption Risks

Architectural Risks

CONNECT

VA HOME

QUICK LIST

RESOURCES

ADMINISTRATION

VA Technical Reference Model v 24.7

General Information

Vendor Release Information

Current Decision Matrix (08/02/2022)

Decision Constraints

References

Technology Components

VA Categories View the VA Categorization Framework

Open Source

Operating Systems Supported by the Technology

Technologies/Standards Relationships

Runtime Dependencies:

Comparable Technologies:

Companion Technologies/Supported Standards:

General Analysis

Adoption Benefits

Adoption Risks

Architectural Risks

EMAIL UPDATES