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
The unique identifier for the vocabulary (e.g., “SNOMED”, “ICD10CM”, “LOINC”)
The specific version identifier (e.g., “2024.2”, “v2024.1”)
Query Parameters
Include version-specific statistical information
Include changes from the previous version
Include backward and forward compatibility information
Include deployment status across environments
Include quality assessment for this version
Compare this version with another specific version
Include download links for version artifacts
Response
Indicates if the request was successful
Usage Examples
Basic Version Information
Get basic information about a specific version:Comprehensive Version Details
Get complete information about a version:Version Comparison
Compare two specific versions:Download Preparation
Get download links for a specific version:Deployment Status Check
Check deployment status across environments:Migration Assessment
Assess compatibility for migration: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
Related Endpoints
- Get Vocabulary Releases - List all versions
- Get Vocabulary Changelog - Detailed change history
- Get Vocabulary Statistics - Statistical analysis
- Get Vocabulary Quality - Quality assessment