Skip to main content
curl -X GET "https://api.omophub.com/v1/vocabularies/SNOMED/releases/2024-03?include_statistics=true&include_changelog=true&include_compatibility=true&include_deployment_status=true" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
{
  "success": true,
  "data": {
    "vocabulary_id": "SNOMED",
    "vocabulary_name": "Systematized Nomenclature of Medicine Clinical Terms",
    "version": "2024.2",
    "release_info": {
      "version_type": "Minor",
      "release_date": "2024-03-01T00:00:00Z",
      "release_notes": "March 2024 release includes new COVID-19 variants, updated cardiovascular procedures, and enhanced psychiatric terminology. This release adds 2,847 new concepts and modifies 1,523 existing concepts based on clinical feedback and emerging medical knowledge.",
      "release_status": "Released",
      "schema_name": "vocabs_2024_1",
      "predecessor_version": "2024-01",
      "successor_version": "2024-07",
      "deprecation_date": null,
      "end_of_life_date": "2026-03-01T00:00:00Z"
    },
    "version_metadata": {
      "source_organization": "SNOMED International",
      "publication_url": "https://www.snomed.org/news-and-events/articles/march-2024-release",
      "license_info": {
        "license_type": "SNOMED CT Affiliate License",
        "commercial_use": true,
        "attribution_required": true
      },
      "checksum": "sha256:a1b2c3d4e5f6789012345678901234567890abcdef",
      "file_size_mb": 4752.3,
      "supported_formats": ["RF2", "JSON", "XML", "CSV"]
    },
    "version_statistics": {
      "total_concepts": 354652,
      "standard_concepts": 298456,
      "new_concepts": 2847,
      "modified_concepts": 1523,
      "deprecated_concepts": 89,
      "total_relationships": 1247832,
      "domain_distribution": [
        {
          "domain_id": "Condition",
          "concept_count": 125643,
          "percentage": 35.4
        },
        {
          "domain_id": "Procedure",
          "concept_count": 87321,
          "percentage": 24.6
        },
        {
          "domain_id": "Observation",
          "concept_count": 65432,
          "percentage": 18.4
        },
        {
          "domain_id": "Measurement",
          "concept_count": 34567,
          "percentage": 9.7
        },
        {
          "domain_id": "Drug",
          "concept_count": 23456,
          "percentage": 6.6
        }
      ]
    },
    "changelog": {
      "summary": {
        "total_changes": 4876,
        "concepts_added": 2847,
        "concepts_modified": 1523,
        "concepts_deprecated": 89,
        "relationships_changed": 417
      },
      "major_changes": [
        "Added 247 new COVID-19 variant concepts including Omicron subvariants",
        "Enhanced cardiovascular procedure terminology with 156 new concepts",
        "Updated psychiatric disorder classifications with DSM-5-TR alignment",
        "Expanded oncology staging concepts for precision medicine"
      ],
      "breaking_changes": [
        "Deprecated legacy cardiac procedure concept 123456789 - migrate to 987654321",
        "Restructured mental health disorder hierarchy - review dependent implementations"
      ],
      "migration_notes": [
        "Review automated coding rules using deprecated cardiac procedures",
        "Update clinical decision support rules referencing restructured mental health concepts",
        "Consider mapping validation for new COVID-19 variant concepts"
      ]
    },
    "compatibility": {
      "backward_compatible": false,
      "compatibility_level": "Partial",
      "breaking_changes_count": 2,
      "deprecated_features": [
        "Legacy cardiac procedure classifications",
        "Outdated mental health disorder groupings"
      ],
      "migration_required": true,
      "supported_integrations": [
        "Epic FHIR R4",
        "Cerner PowerChart",
        "Allscripts",
        "athenahealth",
        "Custom OMOP CDM implementations"
      ],
      "minimum_api_version": "v1.8"
    },
    "deployment_status": {
      "production": {
        "deployed": true,
        "deployment_date": "2024-03-15T14:30:00Z",
        "rollout_percentage": 100,
        "status": "Active"
      },
      "staging": {
        "deployed": true,
        "deployment_date": "2024-03-08T10:00:00Z",
        "rollout_percentage": 100,
        "status": "Active"
      },
      "development": {
        "deployed": true,
        "deployment_date": "2024-03-01T09:00:00Z",
        "rollout_percentage": 100,
        "status": "Active"
      },
      "regions": [
        {
          "region": "us-east-1",
          "status": "Active",
          "deployment_date": "2024-03-15T14:30:00Z"
        },
        {
          "region": "us-west-2",
          "status": "Active",
          "deployment_date": "2024-03-15T14:35:00Z"
        },
        {
          "region": "eu-west-1",
          "status": "Active",
          "deployment_date": "2024-03-15T14:40:00Z"
        }
      ]
    },
    "quality_metrics": {
      "overall_quality_score": 91.7,
      "quality_trend": "Improved",
      "data_completeness": 98.2,
      "validation_results": {
        "schema_validation": "Passed",
        "referential_integrity": "Passed",
        "business_rules": "Passed with 3 warnings",
        "performance_tests": "Passed"
      },
      "known_issues": [
        "Minor synonym inconsistencies in 234 cardiovascular concepts",
        "3 orphaned concepts in device domain require hierarchical placement",
        "Performance optimization needed for deep hierarchy queries"
      ]
    },
    "comparison_analysis": {
      "comparison_version": "2024-01",
      "concept_differences": {
        "concepts_added": 2847,
        "concepts_removed": 12,
        "concepts_modified": 1523
      },
      "unique_concepts": {
        "current_version_unique": 2835,
        "comparison_version_unique": 0
      },
      "relationship_differences": {
        "relationships_added": 417,
        "relationships_removed": 23,
        "relationships_modified": 156
      },
      "recommendation": "Recommended upgrade - significant content enhancements with manageable migration effort"
    },
    "download_information": {
      "download_links": [
        {
          "format": "RF2",
          "url": "https://api.omophub.com/v1/vocabularies/SNOMED/releases/2024-03/download/rf2",
          "size_mb": 4752.3,
          "checksum": "sha256:a1b2c3d4e5f6789012345678901234567890abcdef",
          "expires_at": "2024-01-16T10:30:00Z"
        },
        {
          "format": "JSON",
          "url": "https://api.omophub.com/v1/vocabularies/SNOMED/releases/2024-03/download/json",
          "size_mb": 6834.7,
          "checksum": "sha256:b2c3d4e5f6a17890123456789012345678901bcdef",
          "expires_at": "2024-01-16T10:30:00Z"
        },
        {
          "format": "XML",
          "url": "https://api.omophub.com/v1/vocabularies/SNOMED/releases/2024-03/download/xml",
          "size_mb": 8967.2,
          "checksum": "sha256:c3d4e5f6a7b18901234567890123456789012cdef0",
          "expires_at": "2024-01-16T10:30:00Z"
        }
      ],
      "api_endpoints": [
        "/v1/vocabularies/SNOMED?vocab_release=2024-03",
        "/v1/concepts?vocabulary_id=SNOMED&vocab_release=2024-03",
        "/v1/concepts/search?vocabulary_ids=SNOMED&vocab_release=2024-03"
      ],
      "documentation_links": [
        "https://docs.omophub.com/vocabularies/snomed/2024-03",
        "https://docs.omophub.com/migration-guides/snomed-2024-03",
        "https://docs.omophub.com/release-notes/snomed-2024-03"
      ]
    }
  },
  "meta": {
    "request_id": "req_snomed_version_123",
    "timestamp": "2024-03-15T10:30:00Z",
    "version_availability": "Available",
    "cache_info": {
      "cached": true,
      "cache_expiry": "2024-04-15T22:30:00Z",
      "cache_hit": true
    }
  }
}

Overview

This endpoint provides comprehensive information about a specific vocabulary release version, including version-specific statistics, changes from previous versions, compatibility information, and deployment status across different environments.

Path Parameters

vocabularyId
string
required
The unique identifier for the vocabulary (e.g., “SNOMED”, “ICD10CM”, “LOINC”)
version
string
required
The specific version identifier (e.g., “2024.2”, “v2024.1”)

Query Parameters

include_statistics
boolean
default:"false"
Include version-specific statistical information
include_changelog
boolean
default:"false"
Include changes from the previous version
include_compatibility
boolean
default:"false"
Include backward and forward compatibility information
include_deployment_status
boolean
default:"false"
Include deployment status across environments
include_quality_metrics
boolean
default:"false"
Include quality assessment for this version
compare_with
string
Compare this version with another specific version
Include download links for version artifacts

Response

success
boolean
Indicates if the request was successful
data
object
meta
object
curl -X GET "https://api.omophub.com/v1/vocabularies/SNOMED/releases/2024-03?include_statistics=true&include_changelog=true&include_compatibility=true&include_deployment_status=true" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
{
  "success": true,
  "data": {
    "vocabulary_id": "SNOMED",
    "vocabulary_name": "Systematized Nomenclature of Medicine Clinical Terms",
    "version": "2024.2",
    "release_info": {
      "version_type": "Minor",
      "release_date": "2024-03-01T00:00:00Z",
      "release_notes": "March 2024 release includes new COVID-19 variants, updated cardiovascular procedures, and enhanced psychiatric terminology. This release adds 2,847 new concepts and modifies 1,523 existing concepts based on clinical feedback and emerging medical knowledge.",
      "release_status": "Released",
      "schema_name": "vocabs_2024_1",
      "predecessor_version": "2024-01",
      "successor_version": "2024-07",
      "deprecation_date": null,
      "end_of_life_date": "2026-03-01T00:00:00Z"
    },
    "version_metadata": {
      "source_organization": "SNOMED International",
      "publication_url": "https://www.snomed.org/news-and-events/articles/march-2024-release",
      "license_info": {
        "license_type": "SNOMED CT Affiliate License",
        "commercial_use": true,
        "attribution_required": true
      },
      "checksum": "sha256:a1b2c3d4e5f6789012345678901234567890abcdef",
      "file_size_mb": 4752.3,
      "supported_formats": ["RF2", "JSON", "XML", "CSV"]
    },
    "version_statistics": {
      "total_concepts": 354652,
      "standard_concepts": 298456,
      "new_concepts": 2847,
      "modified_concepts": 1523,
      "deprecated_concepts": 89,
      "total_relationships": 1247832,
      "domain_distribution": [
        {
          "domain_id": "Condition",
          "concept_count": 125643,
          "percentage": 35.4
        },
        {
          "domain_id": "Procedure",
          "concept_count": 87321,
          "percentage": 24.6
        },
        {
          "domain_id": "Observation",
          "concept_count": 65432,
          "percentage": 18.4
        },
        {
          "domain_id": "Measurement",
          "concept_count": 34567,
          "percentage": 9.7
        },
        {
          "domain_id": "Drug",
          "concept_count": 23456,
          "percentage": 6.6
        }
      ]
    },
    "changelog": {
      "summary": {
        "total_changes": 4876,
        "concepts_added": 2847,
        "concepts_modified": 1523,
        "concepts_deprecated": 89,
        "relationships_changed": 417
      },
      "major_changes": [
        "Added 247 new COVID-19 variant concepts including Omicron subvariants",
        "Enhanced cardiovascular procedure terminology with 156 new concepts",
        "Updated psychiatric disorder classifications with DSM-5-TR alignment",
        "Expanded oncology staging concepts for precision medicine"
      ],
      "breaking_changes": [
        "Deprecated legacy cardiac procedure concept 123456789 - migrate to 987654321",
        "Restructured mental health disorder hierarchy - review dependent implementations"
      ],
      "migration_notes": [
        "Review automated coding rules using deprecated cardiac procedures",
        "Update clinical decision support rules referencing restructured mental health concepts",
        "Consider mapping validation for new COVID-19 variant concepts"
      ]
    },
    "compatibility": {
      "backward_compatible": false,
      "compatibility_level": "Partial",
      "breaking_changes_count": 2,
      "deprecated_features": [
        "Legacy cardiac procedure classifications",
        "Outdated mental health disorder groupings"
      ],
      "migration_required": true,
      "supported_integrations": [
        "Epic FHIR R4",
        "Cerner PowerChart",
        "Allscripts",
        "athenahealth",
        "Custom OMOP CDM implementations"
      ],
      "minimum_api_version": "v1.8"
    },
    "deployment_status": {
      "production": {
        "deployed": true,
        "deployment_date": "2024-03-15T14:30:00Z",
        "rollout_percentage": 100,
        "status": "Active"
      },
      "staging": {
        "deployed": true,
        "deployment_date": "2024-03-08T10:00:00Z",
        "rollout_percentage": 100,
        "status": "Active"
      },
      "development": {
        "deployed": true,
        "deployment_date": "2024-03-01T09:00:00Z",
        "rollout_percentage": 100,
        "status": "Active"
      },
      "regions": [
        {
          "region": "us-east-1",
          "status": "Active",
          "deployment_date": "2024-03-15T14:30:00Z"
        },
        {
          "region": "us-west-2",
          "status": "Active",
          "deployment_date": "2024-03-15T14:35:00Z"
        },
        {
          "region": "eu-west-1",
          "status": "Active",
          "deployment_date": "2024-03-15T14:40:00Z"
        }
      ]
    },
    "quality_metrics": {
      "overall_quality_score": 91.7,
      "quality_trend": "Improved",
      "data_completeness": 98.2,
      "validation_results": {
        "schema_validation": "Passed",
        "referential_integrity": "Passed",
        "business_rules": "Passed with 3 warnings",
        "performance_tests": "Passed"
      },
      "known_issues": [
        "Minor synonym inconsistencies in 234 cardiovascular concepts",
        "3 orphaned concepts in device domain require hierarchical placement",
        "Performance optimization needed for deep hierarchy queries"
      ]
    },
    "comparison_analysis": {
      "comparison_version": "2024-01",
      "concept_differences": {
        "concepts_added": 2847,
        "concepts_removed": 12,
        "concepts_modified": 1523
      },
      "unique_concepts": {
        "current_version_unique": 2835,
        "comparison_version_unique": 0
      },
      "relationship_differences": {
        "relationships_added": 417,
        "relationships_removed": 23,
        "relationships_modified": 156
      },
      "recommendation": "Recommended upgrade - significant content enhancements with manageable migration effort"
    },
    "download_information": {
      "download_links": [
        {
          "format": "RF2",
          "url": "https://api.omophub.com/v1/vocabularies/SNOMED/releases/2024-03/download/rf2",
          "size_mb": 4752.3,
          "checksum": "sha256:a1b2c3d4e5f6789012345678901234567890abcdef",
          "expires_at": "2024-01-16T10:30:00Z"
        },
        {
          "format": "JSON",
          "url": "https://api.omophub.com/v1/vocabularies/SNOMED/releases/2024-03/download/json",
          "size_mb": 6834.7,
          "checksum": "sha256:b2c3d4e5f6a17890123456789012345678901bcdef",
          "expires_at": "2024-01-16T10:30:00Z"
        },
        {
          "format": "XML",
          "url": "https://api.omophub.com/v1/vocabularies/SNOMED/releases/2024-03/download/xml",
          "size_mb": 8967.2,
          "checksum": "sha256:c3d4e5f6a7b18901234567890123456789012cdef0",
          "expires_at": "2024-01-16T10:30:00Z"
        }
      ],
      "api_endpoints": [
        "/v1/vocabularies/SNOMED?vocab_release=2024-03",
        "/v1/concepts?vocabulary_id=SNOMED&vocab_release=2024-03",
        "/v1/concepts/search?vocabulary_ids=SNOMED&vocab_release=2024-03"
      ],
      "documentation_links": [
        "https://docs.omophub.com/vocabularies/snomed/2024-03",
        "https://docs.omophub.com/migration-guides/snomed-2024-03",
        "https://docs.omophub.com/release-notes/snomed-2024-03"
      ]
    }
  },
  "meta": {
    "request_id": "req_snomed_version_123",
    "timestamp": "2024-03-15T10:30:00Z",
    "version_availability": "Available",
    "cache_info": {
      "cached": true,
      "cache_expiry": "2024-04-15T22:30:00Z",
      "cache_hit": true
    }
  }
}

Usage Examples

Basic Version Information

Get basic information about a specific version:
curl -X GET "https://api.omophub.com/v1/vocabularies/SNOMED/releases/2024-03" \
  -H "Authorization: Bearer YOUR_API_KEY"

Comprehensive Version Details

Get complete information about a version:
curl -X GET "https://api.omophub.com/v1/vocabularies/SNOMED/releases/2024-03?include_statistics=true&include_changelog=true&include_compatibility=true&include_deployment_status=true&include_quality_metrics=true" \
  -H "Authorization: Bearer YOUR_API_KEY"

Version Comparison

Compare two specific versions:
curl -X GET "https://api.omophub.com/v1/vocabularies/SNOMED/releases/2024-03?compare_with=2024-01&include_statistics=true&include_changelog=true" \
  -H "Authorization: Bearer YOUR_API_KEY"

Download Preparation

Get download links for a specific version:
curl -X GET "https://api.omophub.com/v1/vocabularies/SNOMED/releases/2024-03?include_download_links=true" \
  -H "Authorization: Bearer YOUR_API_KEY"

Deployment Status Check

Check deployment status across environments:
curl -X GET "https://api.omophub.com/v1/vocabularies/ICD10CM/releases/2024-Q1?include_deployment_status=true&include_quality_metrics=true" \
  -H "Authorization: Bearer YOUR_API_KEY"

Migration Assessment

Assess compatibility for migration:
curl -X GET "https://api.omophub.com/v1/vocabularies/LOINC/releases/2.76?include_compatibility=true&include_changelog=true&compare_with=2.75" \
  -H "Authorization: Bearer YOUR_API_KEY"

Version Types

Major Release

  • Significant structural changes
  • May include breaking changes
  • Requires thorough migration planning
  • Annual or bi-annual cadence

Minor Release

  • New concepts and enhancements
  • Limited breaking changes
  • Quarterly or bi-annual releases
  • Moderate migration effort

Patch Release

  • Bug fixes and corrections
  • No breaking changes
  • Monthly or as-needed basis
  • Minimal migration impact

Hotfix Release

  • Critical issue resolution
  • Emergency deployment
  • Immediate availability
  • Focused scope changes

Release Status Values

Released

  • Generally available for production use
  • Full support and documentation available
  • Stable and tested release

Beta

  • Pre-release version for testing
  • Feature complete but may have issues
  • Limited support available

RC (Release Candidate)

  • Final testing before general release
  • Feature freeze in effect
  • Production-ready quality

Deprecated

  • No longer recommended for new implementations
  • Security updates only
  • Migration path available

Deployment Environments

Production

  • Live environment serving end users
  • Highest stability requirements
  • Gradual rollout capability

Staging

  • Pre-production testing environment
  • Mirrors production configuration
  • Final validation before release

Development

  • Development and integration testing
  • Latest features and fixes
  • Higher tolerance for issues

Quality Assessment

Quality Scores

  • 90-100: Excellent quality, ready for production
  • 80-89: Good quality, minor issues acceptable
  • 70-79: Fair quality, review recommended
  • 60-69: Poor quality, significant issues present
  • Below 60: Unacceptable quality, not recommended

Validation Tests

  • Schema validation ensures data structure compliance
  • Referential integrity checks relationship validity
  • Business rules validate domain-specific constraints
  • Performance tests ensure acceptable query response times
I