Skip to main content
curl -X GET "https://api.omophub.com/v1/vocabularies/releases" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "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.4",
      "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

​
include_inactive
boolean
default:"false"
Include inactive releases in the response. By default, only active releases are returned.

​
Response

​
success
boolean
Indicates if the request was successful.
​
data
array
Array of vocabulary release objects.
​
meta
object
curl -X GET "https://api.omophub.com/v1/vocabularies/releases" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "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.4",
      "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_default release is used when no specific version is requested
  • Use the vocab_release value (e.g., “2025.1”) in the vocab_release query parameter of other endpoints to query specific versions