List All Vocabularies
Get a paginated list of all available medical vocabularies:Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
include_stats | logical | FALSE | Include vocabulary statistics |
include_inactive | logical | FALSE | Include inactive vocabularies |
sort_by | character | ”name” | Sort field (“name”, “priority”, “updated”) |
sort_order | character | ”asc” | Sort order (“asc”, “desc”) |
page | integer | 1 | Page number |
page_size | integer | 100 | Results per page (max 1000) |
Get Vocabulary Details
Get detailed information about a specific vocabulary:Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
vocabulary_id | character | required | Vocabulary identifier (e.g., “SNOMED”, “ICD10CM”) |
Response Fields
Returnsvocabulary_id, vocabulary_name, vocabulary_reference, vocabulary_version, vocabulary_concept_id.
For detailed statistics, use client$vocabularies$stats(vocabulary_id).
Get Vocabulary Statistics
Get statistical information about a vocabulary:Get Domain Statistics
Get statistics for a specific domain within a vocabulary:Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
vocabulary_id | character | required | Vocabulary identifier (e.g., “SNOMED”, “ICD10CM”) |
domain_id | character | required | Domain identifier (e.g., “Condition”, “Drug”, “Procedure”) |
Get Vocabulary Domains
Get all standard OHDSI domains:domain_id, domain_name, and description.
Get Concept Classes
Get all available concept classes:concept_class_id, concept_class_name, and concept_class_concept_id.
Get Vocabulary Concepts
Retrieve concepts within a specific vocabulary with filtering and pagination:Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
vocabulary_id | character | required | Vocabulary identifier (e.g., “SNOMED”, “ICD10CM”) |
search | character | NULL | Search term to filter concepts by name or code |
standard_concept | character | ”all” | Filter by standard concept status (“S”, “C”, “all”) |
include_invalid | logical | FALSE | Include invalid or deprecated concepts |
include_relationships | logical | FALSE | Include concept relationships in response |
include_synonyms | logical | FALSE | Include concept synonyms in response |
sort_by | character | ”name” | Sort field (“name”, “concept_id”, “concept_code”) |
sort_order | character | ”asc” | Sort order (“asc”, “desc”) |
page | integer | 1 | Page number |
page_size | integer | 20 | Results per page (max 1000) |