Man pages for OHDSI/ROhdsiWebApi
Interacting With an OHDSI WebApi Instance

authorizeWebApiAuthorize ROhdsiWebApi to access a protected instance of...
cancelCharacterizationGenerationCancel generation of Characterization id.
cancelCohortGenerationCancel generation of Cohort id.
cancelGenerationInvoke generation.
cancelIncidenceRateGenerationCancel generation of IncidenceRate id.
cancelPathwayGenerationCancel generation of Pathway id.
checkInputFileEncodingCheck character encoding of input file
convertConceptSetDefinitionToTableConvert a concept set definition to a table
createConceptSetWorkbookSave a set of concept sets expressions, included concepts,...
deleteCharacterizationDefinitionDelete Characterization id definition.
deleteCohortDefinitionDelete Cohort id definition.
deleteConceptSetDefinitionDelete ConceptSet id definition.
deleteDefinitionDelete a definition id of a chosen category.
deleteEstimationDefinitionDelete Estimation id definition.
deleteIncidenceRateDefinitionDelete IncidenceRate id definition.
deletePathwayDefinitionDelete Pathway id definition.
deletePredictionDefinitionDelete Prediction id definition.
detectCharacterizationsByNameDetect the presence of string matched Characterization...
detectCohortsByNameDetect the presence of string matched Cohort definitions.
detectConceptSetsByNameDetect the presence of string matched ConceptSet definitions.
detectEstimationsByNameDetect the presence of string matched Estimation definitions.
detectIncidenceRatesByNameDetect the presence of string matched IncidenceRate...
detectPathwaysByNameDetect the presence of string matched Pathway definitions.
detectPredictionsByNameDetect the presence of string matched Prediction definitions.
existsCharacterizationNameCheck if Characterization definition name exists.
existsCohortNameCheck if Cohort definition name exists.
existsConceptSetNameCheck if ConceptSet definition name exists.
existsEstimationNameCheck if Estimation definition name exists.
existsIncidenceRateNameCheck if IncidenceRate definition name exists.
existsPathwayNameCheck if Pathway definition name exists.
existsPredictionNameCheck if Prediction definition name exists.
exportCohortDefinitionSetExport cohort definition set from WebAPI
getCdmSourcesGet the data sources in the WebAPI instance
getCharacterizationDefinitionGet Characterization id definition.
getCharacterizationDefinitionsMetaDataGet the meta data for Characterization definitions.
getCharacterizationGenerationInformationGet generation information for Characterization id.
getCharacterizationResultsGet results for a Characterization Id.
getCohortDefinitionGet Cohort id definition.
getCohortDefinitionExpression(Deprecated) Get a cohort definition expression
getCohortDefinitionName(Deprecated) Get a cohort definition's name from WebAPI
getCohortDefinitionsMetaDataGet the meta data for Cohort definitions.
getCohortDefinitionSqlGet a cohort definition's SQL from WebAPI
getCohortGenerationInformationGet generation information for Cohort id.
getCohortInclusionRulesAndCountsGet cohort inclusion rules and person counts
getCohortResultsGet results for a Cohort Id.
getCohortSqlGet SQL query for Cohort definition.
getConceptsGet concepts
getConceptSetDefinitionGet ConceptSet id definition.
getConceptSetDefinitionBySourceKeyFetch concept set definition from WebAPI by SourceKey
getConceptSetDefinitionsMetaDataGet the meta data for ConceptSet definitions.
getDefinitionGet the definition for an id of chosen category in WebApi.
getDefinitionsMetadataRetrieve the meta data for WebApi definitions of a certain...
getEstimationDefinitionGet Estimation id definition.
getEstimationDefinitionsMetaDataGet the meta data for Estimation definitions.
getGenerationInformationGet generation information.
getIncidenceRateDefinitionGet IncidenceRate id definition.
getIncidenceRateDefinitionsMetaDataGet the meta data for IncidenceRate definitions.
getIncidenceRateGenerationInformationGet generation information for IncidenceRate id.
getIncidenceRateResultsGet results for a IncidenceRate Id.
getPathwayDefinitionGet Pathway id definition.
getPathwayDefinitionsMetaDataGet the meta data for Pathway definitions.
getPathwayGenerationInformationGet generation information for Pathway id.
getPathwayResultsGet results for a Pathway Id.
getPersonProfileGet person profile data
getPredictionDefinitionGet Prediction id definition.
getPredictionDefinitionsMetaDataGet the meta data for Prediction definitions.
getPriorityVocabularyKeyGet Priority Vocabulary Source Key
getResultsGet generation results
getSourceConceptsGet source concepts that map to standard concepts
getWebApiVersionGet the WebAPI version number
insertCohortDefinitionInPackageLoad a cohort definition and insert it into this package
insertCohortDefinitionSetInPackageInsert a set of cohort definitions into package
invokeCharacterizationGenerationInvoke generation of Characterization id.
invokeCohortGenerationInvoke generation of Cohort id.
invokeGenerationInvoke generation.
invokeIncidenceRateGenerationInvoke generation of IncidenceRate id.
invokePathwayGenerationInvoke generation of Pathway id.
isValidCharacterizationIdis Characterization id a valid definition in the WebApi.
isValidCohortIdis Cohort id a valid definition in the WebApi.
isValidConceptSetIdis ConceptSet id a valid definition in the WebApi.
isValidEstimationIdis Estimation id a valid definition in the WebApi.
isValidIdCheck if an id is valid.
isValidIncidenceRateIdis IncidenceRate id a valid definition in the WebApi.
isValidPathwayIdis Pathway id a valid definition in the WebApi.
isValidPredictionIdis Prediction id a valid definition in the WebApi.
isValidSourceKeyCheck if source key is valid.
postCharacterizationDefinitionPost Characterization definition.
postCohortDefinitionPost Cohort definition.
postConceptSetDefinitionPost ConceptSet definition.
postDefinitionPost a definition into WebApi
postEstimationDefinitionPost Estimation definition.
postIncidenceRateDefinitionPost IncidenceRate definition.
postPathwayDefinitionPost Pathway definition.
postPredictionDefinitionPost Prediction definition.
resolveConceptSetResolve a concept set to the included standard concept IDs
ROhdsiWebApi-packageROhdsiWebApi: Interacting With an OHDSI WebApi Instance
setAuthHeaderManually set the authorization http header for a WebAPI...
updateCohortDefinitionUpdate a Cohort definition.
updateConceptSetDefinitionUpdate a ConceptSet definition.
updateDefinitionUpdate definition
OHDSI/ROhdsiWebApi documentation built on March 15, 2023, 1:23 p.m.