OHDSI WebAPI contains all OHDSI RESTful services that can be called from OHDSI applications.
- Provides a centralized API for working with 1 or more databases converted to the Common Data Model (CDM) v5.
- Searching the OMOP standardized vocabularies for medical concepts and constructing concept sets.
- Defining cohort definitions for use in identifying patient populations.
- Characterizing cohorts
- Computing incidence rates
- Retrieve patient profiles
- Design population level estimation and patient level prediction studies
OHDSI WebAPI is a Java 8 web application that utilizes a PostgreSQL database for storage.
The API Documentation is found at http://webapidoc.ohdsi.org/
Documentation can be found a the Web API Installation Guide which covers the system requirements and installation instructions.
The following parameters are used:
security.saml.idpMetadataLocation=classpath:saml/dev/idp-metadata.xml- path to metadata used by identity providersecurity.saml.metadataLocation=saml/dev/sp-metadata.xml- service provider metadata pathsecurity.saml.keyManager.keyStoreFile=classpath:saml/samlKeystore.jks- path to keystoresecurity.saml.keyManager.storePassword=nalle123- keystore passwordsecurity.saml.keyManager.passwords.arachnenetwork=nalle123- private key passwordsecurity.saml.keyManager.defaultKey=apollo- keystore aliassecurity.saml.sloUrl=https://localhost:8443/cas/logout- identity provider logout URLsecurity.saml.callbackUrl=http://localhost:8080/WebAPI/user/saml/callback- URL called from identity provider after login
Sample idp metadata and sp metadata config files for okta:
saml/dev/idp-metadata-okta.xmlsaml/dev/sp-metadata-okta.xml
The following parameters are used to enable/disable certain provider:
security.auth.windows.enabledsecurity.auth.kerberos.enabledsecurity.auth.openid.enabledsecurity.auth.facebook.enabledsecurity.auth.github.enabledsecurity.auth.google.enabledsecurity.auth.jdbc.enabledsecurity.auth.ldap.enabledsecurity.auth.ad.enabledsecurity.auth.cas.enabled
Acceptable values are true and false
Instructions can be found at webapi-component-geospatial
It was chosen to use embedded PG instead of H2 for unit tests since H2 doesn't support window functions, md5 function, HEX to BIT conversion, setval, set datestyle, CTAS + CTE.
- Developer questions/comments/feedback: OHDSI forum
- We use the GitHub issue tracker for all bugs/issues/enhancements.
- WebAPI follows Semantic versioning;
- Only Non-SNAPSHOT dependencies should be presented in POM.xml on release branches/tags.
OHDSI WebAPI is licensed under Apache License 2.0
