Skip to main content
curl -X GET "https://api.omophub.com/v1/vocabularies/SNOMED/metadata?include_changelog=true&include_licensing=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",
    "vocabulary_reference": "https://www.snomed.org/",
    "vocabulary_version": "2024.2",
    "vocabulary_concept_id": 44819096,
    "release_info": {
      "current_version": "2024.2",
      "release_date": "2024-03-01T00:00:00Z",
      "next_expected_release": "2024-07-01T00:00:00Z",
      "release_frequency": "Bi-annual (January and July)",
      "schema_name": "vocabs_2024_1"
    },
    "content_info": {
      "total_concepts": 354652,
      "standard_concepts": 298456,
      "classification_concepts": 56196,
      "primary_domains": [
        "Condition",
        "Procedure",
        "Observation",
        "Specimen",
        "Measurement"
      ],
      "concept_classes": [
        "Clinical Finding",
        "Procedure",
        "Observable Entity",
        "Body Structure",
        "Substance",
        "Pharmaceutical / biologic product"
      ],
      "languages_supported": [
        "en-US",
        "en-GB",
        "es-ES",
        "fr-FR",
        "de-DE"
      ]
    },
    "organization_info": {
      "maintaining_organization": "SNOMED International",
      "contact_info": "info@snomed.org",
      "official_website": "https://www.snomed.org/",
      "documentation_url": "https://confluence.ihtsdotools.org/"
    },
    "licensing_info": {
      "license_type": "Commercial with Free Tier",
      "license_description": "Free for SNOMED International member countries, commercial licensing available for others",
      "attribution_required": true,
      "commercial_use_allowed": true,
      "license_url": "https://www.snomed.org/snomed-ct/get-snomed"
    },
    "technical_info": {
      "encoding": "UTF-8",
      "file_formats": [
        "RF2 (Release Format 2)",
        "JSON",
        "XML",
        "CSV"
      ],
      "api_endpoints": [
        "/v1/concepts",
        "/v1/concepts/:id/ancestors",
        "/v1/concepts/:id/descendants",
        "/v1/concepts/search"
      ],
      "identifier_format": "SCTID (SNOMED CT Identifier) - up to 18 digits",
      "hierarchy_depth": {
        "max_depth": 15,
        "average_depth": 6.8,
        "deepest_path": "Clinical finding > Disease > Cardiovascular disease > ..."
      }
    },
    "changelog": [
      {
        "version": "2024.2",
        "change_date": "2024-03-01T00:00:00Z",
        "change_type": "Added",
        "description": "New concepts for COVID-19 variants and long COVID conditions",
        "affected_concepts": 247
      },
      {
        "version": "2024.2",
        "change_date": "2024-03-01T00:00:00Z",
        "change_type": "Modified",
        "description": "Updated relationships for cardiovascular procedure concepts",
        "affected_concepts": 1523
      },
      {
        "version": "2024-01",
        "change_date": "2024-01-01T00:00:00Z",
        "change_type": "Deprecated",
        "description": "Deprecated outdated medication concepts",
        "affected_concepts": 89
      }
    ]
  },
  "meta": {
    "request_id": "req_snomed_metadata_123",
    "timestamp": "2024-01-15T10:30:00Z",
    "vocab_release": "2025.2"
  }
}

Overview

This endpoint provides detailed metadata about a specific vocabulary, including version information, licensing details, source references, update history, and technical specifications.

Path Parameters

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

Query Parameters

include_changelog
boolean
default:"false"
Include recent changelog entries
include_licensing
boolean
default:"false"
Include detailed licensing information
vocab_release
string
Specific vocabulary release version (defaults to latest)

Response

success
boolean
Indicates if the request was successful
data
object
meta
object
curl -X GET "https://api.omophub.com/v1/vocabularies/SNOMED/metadata?include_changelog=true&include_licensing=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",
    "vocabulary_reference": "https://www.snomed.org/",
    "vocabulary_version": "2024.2",
    "vocabulary_concept_id": 44819096,
    "release_info": {
      "current_version": "2024.2",
      "release_date": "2024-03-01T00:00:00Z",
      "next_expected_release": "2024-07-01T00:00:00Z",
      "release_frequency": "Bi-annual (January and July)",
      "schema_name": "vocabs_2024_1"
    },
    "content_info": {
      "total_concepts": 354652,
      "standard_concepts": 298456,
      "classification_concepts": 56196,
      "primary_domains": [
        "Condition",
        "Procedure",
        "Observation",
        "Specimen",
        "Measurement"
      ],
      "concept_classes": [
        "Clinical Finding",
        "Procedure",
        "Observable Entity",
        "Body Structure",
        "Substance",
        "Pharmaceutical / biologic product"
      ],
      "languages_supported": [
        "en-US",
        "en-GB",
        "es-ES",
        "fr-FR",
        "de-DE"
      ]
    },
    "organization_info": {
      "maintaining_organization": "SNOMED International",
      "contact_info": "info@snomed.org",
      "official_website": "https://www.snomed.org/",
      "documentation_url": "https://confluence.ihtsdotools.org/"
    },
    "licensing_info": {
      "license_type": "Commercial with Free Tier",
      "license_description": "Free for SNOMED International member countries, commercial licensing available for others",
      "attribution_required": true,
      "commercial_use_allowed": true,
      "license_url": "https://www.snomed.org/snomed-ct/get-snomed"
    },
    "technical_info": {
      "encoding": "UTF-8",
      "file_formats": [
        "RF2 (Release Format 2)",
        "JSON",
        "XML",
        "CSV"
      ],
      "api_endpoints": [
        "/v1/concepts",
        "/v1/concepts/:id/ancestors",
        "/v1/concepts/:id/descendants",
        "/v1/concepts/search"
      ],
      "identifier_format": "SCTID (SNOMED CT Identifier) - up to 18 digits",
      "hierarchy_depth": {
        "max_depth": 15,
        "average_depth": 6.8,
        "deepest_path": "Clinical finding > Disease > Cardiovascular disease > ..."
      }
    },
    "changelog": [
      {
        "version": "2024.2",
        "change_date": "2024-03-01T00:00:00Z",
        "change_type": "Added",
        "description": "New concepts for COVID-19 variants and long COVID conditions",
        "affected_concepts": 247
      },
      {
        "version": "2024.2",
        "change_date": "2024-03-01T00:00:00Z",
        "change_type": "Modified",
        "description": "Updated relationships for cardiovascular procedure concepts",
        "affected_concepts": 1523
      },
      {
        "version": "2024-01",
        "change_date": "2024-01-01T00:00:00Z",
        "change_type": "Deprecated",
        "description": "Deprecated outdated medication concepts",
        "affected_concepts": 89
      }
    ]
  },
  "meta": {
    "request_id": "req_snomed_metadata_123",
    "timestamp": "2024-01-15T10:30:00Z",
    "vocab_release": "2025.2"
  }
}

Usage Examples

Basic Metadata

Get basic vocabulary metadata:
curl -X GET "https://api.omophub.com/v1/vocabularies/SNOMED/metadata" \
  -H "Authorization: Bearer YOUR_API_KEY"

Complete Information

Get comprehensive metadata with changelog and licensing:
curl -X GET "https://api.omophub.com/v1/vocabularies/SNOMED/metadata?include_changelog=true&include_licensing=true" \
  -H "Authorization: Bearer YOUR_API_KEY"

Specific Version

Get metadata for a specific release version:
curl -X GET "https://api.omophub.com/v1/vocabularies/SNOMED/metadata?vocab_release=2024-01" \
  -H "Authorization: Bearer YOUR_API_KEY"

Multiple Vocabularies (sequential calls)

Get metadata for multiple vocabularies by calling the endpoint for each vocabulary ID:
# Define vocabularies to query
VOCABULARIES=("SNOMED" "ICD10CM" "LOINC" "RxNorm")

# Loop through each vocabulary
for vocab in "${VOCABULARIES[@]}"; do
  echo "Getting metadata for $vocab..."
  curl -X GET "https://api.omophub.com/v1/vocabularies/$vocab/metadata?include_licensing=true" \
    -H "Authorization: Bearer YOUR_API_KEY" \
    -H "Accept: application/json" | jq '.'
  echo "---"
done

Common Vocabulary Characteristics

Clinical Terminologies

  • SNOMED CT: Comprehensive clinical terminology with deep hierarchies
  • ICD-10-CM: Diagnostic classification system with administrative focus
  • LOINC: Laboratory and clinical observation identifiers

Drug Terminologies

  • RxNorm: Normalized medication names and relationships
  • NDC: National Drug Code directory
  • ATC: Anatomical Therapeutic Chemical classification

Procedure Terminologies

  • HCPCS Level I: Healthcare procedure codes for billing
  • ICD-10-PCS: Procedural classification system
  • HCPCS: Healthcare Common Procedure Coding System
I