curl -X GET "https://api.omophub.com/v1/vocabularies/releases" \
-H "Authorization: Bearer YOUR_API_KEY"
curl -X GET "https://api.omophub.com/v1/vocabularies/releases?include_inactive=true" \
-H "Authorization: Bearer YOUR_API_KEY"
import requests
response = requests.get(
"https://api.omophub.com/v1/vocabularies/releases",
headers={"Authorization": "Bearer YOUR_API_KEY"}
)
data = response.json()
for release in data["data"]:
print(f"{release['vocab_release']}: {release['total_concepts']} concepts")
import { OMOPHub } from '@omophub/omophub-node';
// Not yet exposed as a dedicated SDK method — use the typed low-level helper.
const client = new OMOPHub();
const { data } = await client.get<unknown[]>('/vocabularies/releases');
console.log(data);
{
"success": true,
"data": [
{
"id": 1,
"vocab_release": "2025.1",
"version_number": "1",
"athena_version": "v5.3.1",
"release_date": "2025-01-01T00:00:00Z",
"status": "ready",
"is_default": true,
"is_active": true,
"total_concepts": 8547321,
"total_vocabularies": 87,
"total_relationships": 45678234
},
{
"id": 2,
"vocab_release": "2024.2",
"version_number": "4",
"athena_version": "v5.3.0",
"release_date": "2024-10-01T00:00:00Z",
"status": "ready",
"is_default": false,
"is_active": true,
"total_concepts": 8234567,
"total_vocabularies": 85,
"total_relationships": 44567123
}
],
"meta": {
"request_id": "req_abc123def456",
"timestamp": "2025-01-05T10:30:00Z",
"vocab_release": "2025.1",
"pagination": {
"page": 1,
"page_size": 2,
"total_items": 2,
"total_pages": 1,
"has_next": false,
"has_previous": false
}
}
}
Get Vocabulary Releases
Retrieve the list of all available OHDSI OMOP vocabulary dataset releases, including release dates, version identifiers, and validity metadata.
curl -X GET "https://api.omophub.com/v1/vocabularies/releases" \
-H "Authorization: Bearer YOUR_API_KEY"
curl -X GET "https://api.omophub.com/v1/vocabularies/releases?include_inactive=true" \
-H "Authorization: Bearer YOUR_API_KEY"
import requests
response = requests.get(
"https://api.omophub.com/v1/vocabularies/releases",
headers={"Authorization": "Bearer YOUR_API_KEY"}
)
data = response.json()
for release in data["data"]:
print(f"{release['vocab_release']}: {release['total_concepts']} concepts")
import { OMOPHub } from '@omophub/omophub-node';
// Not yet exposed as a dedicated SDK method — use the typed low-level helper.
const client = new OMOPHub();
const { data } = await client.get<unknown[]>('/vocabularies/releases');
console.log(data);
{
"success": true,
"data": [
{
"id": 1,
"vocab_release": "2025.1",
"version_number": "1",
"athena_version": "v5.3.1",
"release_date": "2025-01-01T00:00:00Z",
"status": "ready",
"is_default": true,
"is_active": true,
"total_concepts": 8547321,
"total_vocabularies": 87,
"total_relationships": 45678234
},
{
"id": 2,
"vocab_release": "2024.2",
"version_number": "4",
"athena_version": "v5.3.0",
"release_date": "2024-10-01T00:00:00Z",
"status": "ready",
"is_default": false,
"is_active": true,
"total_concepts": 8234567,
"total_vocabularies": 85,
"total_relationships": 44567123
}
],
"meta": {
"request_id": "req_abc123def456",
"timestamp": "2025-01-05T10:30:00Z",
"vocab_release": "2025.1",
"pagination": {
"page": 1,
"page_size": 2,
"total_items": 2,
"total_pages": 1,
"has_next": false,
"has_previous": false
}
}
}
Retrieve information about all OHDSI vocabulary dataset releases available in the system. Each release represents a complete vocabulary dataset version (e.g., “2025.1”) containing all OMOP vocabularies at a specific point in time.
Query Parameters
boolean
default:"false"
Include inactive releases in the response. By default, only active releases are returned.
Response
boolean
Indicates if the request was successful.
array
Array of vocabulary release objects.
Show Release Object
Show Release Object
integer
Unique identifier for the release.
string
Release identifier (e.g., “2025.1”, “2024.2”).
string
Version number.
string
ATHENA vocabulary version this release is based on.
string
ISO 8601 formatted release date.
string
Release status (e.g., “ready”, “pending”, “deprecated”).
boolean
Whether this is the default release used when no version is specified.
boolean
Whether this release is currently active and available for use.
integer
Total number of concepts across all vocabularies in this release.
integer
Number of vocabularies included in this release.
integer
Total number of concept relationships in this release.
object
Show Metadata
Show Metadata
string
Unique identifier for the request.
string
Request timestamp.
string
Current default vocabulary release.
curl -X GET "https://api.omophub.com/v1/vocabularies/releases" \
-H "Authorization: Bearer YOUR_API_KEY"
curl -X GET "https://api.omophub.com/v1/vocabularies/releases?include_inactive=true" \
-H "Authorization: Bearer YOUR_API_KEY"
import requests
response = requests.get(
"https://api.omophub.com/v1/vocabularies/releases",
headers={"Authorization": "Bearer YOUR_API_KEY"}
)
data = response.json()
for release in data["data"]:
print(f"{release['vocab_release']}: {release['total_concepts']} concepts")
import { OMOPHub } from '@omophub/omophub-node';
// Not yet exposed as a dedicated SDK method — use the typed low-level helper.
const client = new OMOPHub();
const { data } = await client.get<unknown[]>('/vocabularies/releases');
console.log(data);
{
"success": true,
"data": [
{
"id": 1,
"vocab_release": "2025.1",
"version_number": "1",
"athena_version": "v5.3.1",
"release_date": "2025-01-01T00:00:00Z",
"status": "ready",
"is_default": true,
"is_active": true,
"total_concepts": 8547321,
"total_vocabularies": 87,
"total_relationships": 45678234
},
{
"id": 2,
"vocab_release": "2024.2",
"version_number": "4",
"athena_version": "v5.3.0",
"release_date": "2024-10-01T00:00:00Z",
"status": "ready",
"is_default": false,
"is_active": true,
"total_concepts": 8234567,
"total_vocabularies": 85,
"total_relationships": 44567123
}
],
"meta": {
"request_id": "req_abc123def456",
"timestamp": "2025-01-05T10:30:00Z",
"vocab_release": "2025.1",
"pagination": {
"page": 1,
"page_size": 2,
"total_items": 2,
"total_pages": 1,
"has_next": false,
"has_previous": false
}
}
}
Usage Examples
Get Active Releases
curl -X GET "https://api.omophub.com/v1/vocabularies/releases" \
-H "Authorization: Bearer YOUR_API_KEY"
Include Inactive Releases
curl -X GET "https://api.omophub.com/v1/vocabularies/releases?include_inactive=true" \
-H "Authorization: Bearer YOUR_API_KEY"
Notes
- Each release represents a complete OHDSI vocabulary dataset at a point in time
- The
is_defaultrelease is used when no specific version is requested - Use the
vocab_releasevalue (e.g., “2025.1”) in thevocab_releasequery parameter of other endpoints to query specific versions
Related Endpoints
- List Vocabularies - Get all vocabularies in a release
Was this page helpful?
⌘I