Function reference • ROhdsiWebApi

All functions
`authorizeWebApi()`	Authorize ROhdsiWebApi to access a protected instance of WebAPI Authorize the ROhdsiWebApi package to access WebApi on behalf of the user. This can be done with any of the auth methods described below. authorizeWebApi will use attempt to retrieve, cache, and update a token which will grant access to webAPI by all subsequent requests made by the package.
`cancelCharacterizationGeneration()`	Cancel generation of Characterization id.
`cancelCohortGeneration()`	Cancel generation of Cohort id.
`cancelGeneration()`	Invoke generation.
`cancelIncidenceRateGeneration()`	Cancel generation of IncidenceRate id.
`cancelPathwayGeneration()`	Cancel generation of Pathway id.
`checkInputFileEncoding()`	Check character encoding of input file
`convertConceptSetDefinitionToTable()`	Convert a concept set definition to a table
`createConceptSetWorkbook()`	Save a set of concept sets expressions, included concepts, and mapped concepts into a workbook
`deleteCharacterizationDefinition()`	Delete Characterization id definition.
`deleteCohortDefinition()`	Delete Cohort id definition.
`deleteConceptSetDefinition()`	Delete ConceptSet id definition.
`deleteDefinition()`	Delete a definition id of a chosen category.
`deleteEstimationDefinition()`	Delete Estimation id definition.
`deleteIncidenceRateDefinition()`	Delete IncidenceRate id definition.
`deletePathwayDefinition()`	Delete Pathway id definition.
`deletePredictionDefinition()`	Delete Prediction id definition.
`detectCharacterizationsByName()`	Detect the presence of string matched Characterization definitions.
`detectCohortsByName()`	Detect the presence of string matched Cohort definitions.
`detectConceptSetsByName()`	Detect the presence of string matched ConceptSet definitions.
`detectEstimationsByName()`	Detect the presence of string matched Estimation definitions.
`detectIncidenceRatesByName()`	Detect the presence of string matched IncidenceRate definitions.
`detectPathwaysByName()`	Detect the presence of string matched Pathway definitions.
`detectPredictionsByName()`	Detect the presence of string matched Prediction definitions.
`existsCharacterizationName()`	Check if Characterization definition name exists.
`existsCohortName()`	Check if Cohort definition name exists.
`existsConceptSetName()`	Check if ConceptSet definition name exists.
`existsEstimationName()`	Check if Estimation definition name exists.
`existsIncidenceRateName()`	Check if IncidenceRate definition name exists.
`existsPathwayName()`	Check if Pathway definition name exists.
`existsPredictionName()`	Check if Prediction definition name exists.
`exportCohortDefinitionSet()`	Export cohort definition set from WebAPI
`getCdmSources()`	Get the data sources in the WebAPI instance
`getCharacterizationDefinition()`	Get Characterization id definition.
`getCharacterizationDefinitionsMetaData()`	Get the meta data for Characterization definitions.
`getCharacterizationGenerationInformation()`	Get generation information for Characterization id.
`getCharacterizationResults()`	Get results for a Characterization Id.
`getCohortDefinition()`	Get Cohort id definition.
`getCohortDefinitionExpression()`	(Deprecated) Get a cohort definition expression
`getCohortDefinitionName()`	(Deprecated) Get a cohort definition's name from WebAPI
`getCohortDefinitionsMetaData()`	Get the meta data for Cohort definitions.
`getCohortDefinitionSql()`	Get a cohort definition's SQL from WebAPI
`getCohortGenerationInformation()`	Get generation information for Cohort id.
`getCohortInclusionRulesAndCounts()`	Get cohort inclusion rules and person counts
`getCohortResults()`	Get results for a Cohort Id.
`getCohortSql()`	Get SQL query for Cohort definition.
`getConcepts()`	Get concepts
`getConceptSetDefinition()`	Get ConceptSet id definition.
`getConceptSetDefinitionBySourceKey()`	Fetch concept set definition from WebAPI by SourceKey
`getConceptSetDefinitionsMetaData()`	Get the meta data for ConceptSet definitions.
`getDefinition()`	Get the definition for an id of chosen category in WebApi.
`getDefinitionsMetadata()`	Retrieve the meta data for WebApi definitions of a certain category
`getEstimationDefinition()`	Get Estimation id definition.
`getEstimationDefinitionsMetaData()`	Get the meta data for Estimation definitions.
`getGenerationInformation()`	Get generation information.
`getIncidenceRateDefinition()`	Get IncidenceRate id definition.
`getIncidenceRateDefinitionsMetaData()`	Get the meta data for IncidenceRate definitions.
`getIncidenceRateGenerationInformation()`	Get generation information for IncidenceRate id.
`getIncidenceRateResults()`	Get results for a IncidenceRate Id.
`getPathwayDefinition()`	Get Pathway id definition.
`getPathwayDefinitionsMetaData()`	Get the meta data for Pathway definitions.
`getPathwayGenerationInformation()`	Get generation information for Pathway id.
`getPathwayResults()`	Get results for a Pathway Id.
`getPersonProfile()`	Get person profile data
`getPredictionDefinition()`	Get Prediction id definition.
`getPredictionDefinitionsMetaData()`	Get the meta data for Prediction definitions.
`getPriorityVocabularyKey()`	Get Priority Vocabulary Source Key
`getResults()`	Get generation results
`getSourceConcepts()`	Get source concepts that map to standard concepts
`getWebApiVersion()`	Get the WebAPI version number
`insertCohortDefinitionInPackage()`	Load a cohort definition and insert it into this package
`insertCohortDefinitionSetInPackage()`	Insert a set of cohort definitions into package
`invokeCharacterizationGeneration()`	Invoke generation of Characterization id.
`invokeCohortGeneration()`	Invoke generation of Cohort id.
`invokeGeneration()`	Invoke generation.
`invokeIncidenceRateGeneration()`	Invoke generation of IncidenceRate id.
`invokePathwayGeneration()`	Invoke generation of Pathway id.
`isValidCharacterizationId()`	is Characterization id a valid definition in the WebApi.
`isValidCohortId()`	is Cohort id a valid definition in the WebApi.
`isValidConceptSetId()`	is ConceptSet id a valid definition in the WebApi.
`isValidEstimationId()`	is Estimation id a valid definition in the WebApi.
`isValidId()`	Check if an id is valid.
`isValidIncidenceRateId()`	is IncidenceRate id a valid definition in the WebApi.
`isValidPathwayId()`	is Pathway id a valid definition in the WebApi.
`isValidPredictionId()`	is Prediction id a valid definition in the WebApi.
`isValidSourceKey()`	Check if source key is valid.
`postCharacterizationDefinition()`	Post Characterization definition.
`postCohortDefinition()`	Post Cohort definition.
`postConceptSetDefinition()`	Post ConceptSet definition.
`postDefinition()`	Post a definition into WebApi
`postEstimationDefinition()`	Post Estimation definition.
`postIncidenceRateDefinition()`	Post IncidenceRate definition.
`postPathwayDefinition()`	Post Pathway definition.
`postPredictionDefinition()`	Post Prediction definition.
`resolveConceptSet()`	Resolve a concept set to the included standard concept IDs
`setAuthHeader()`	Manually set the authorization http header for a WebAPI baseUrl In some cases the user may want to manually set the authorization header. An authHeader is associated with a particular baseUrl and added to to the header of all http requests sent to that url by ROhdsiWebApi.
`updateCohortDefinition()`	Update a Cohort definition.
`updateConceptSetDefinition()`	Update a ConceptSet definition.
`updateDefinition()`	Update definition

Reference

All functions