43.19.1Version Endpoint

 

The Version endpoint provides system version information for both Smile CDR and HAPI FHIR components. This endpoint is useful for troubleshooting, support requests, and verifying the installed software versions.

This method requires the ACCESS_ADMIN_JSON permission.

This method returns version information including:

  • Smile CDR version, build number, and build timestamp
  • HAPI FHIR version and build timestamp

To invoke:

GET http://localhost:9000/version/

The server will produce a response containing version information:

{
  "cdrVersion": {
    "version": "2025.02.R01-SNAPSHOT",
    "buildNumber": "202501151234",
    "buildTimestamp": "2025-01-15T12:34:56.789Z"
  },
  "hapiVersion": {
    "version": "7.6.0",
    "buildNumber": "NA",
    "buildTimestamp": "2024-12-10T08:30:15.123Z"
  }
}

43.19.1.1Response Format

The response contains two main objects:

43.19.1.1.1cdrVersion

Contains Smile CDR specific version information:

  • version - The Smile CDR version string (e.g., "2025.02.R01-SNAPSHOT")
  • buildNumber - The build number for this Smile CDR release
  • buildTimestamp - ISO 8601 timestamp when this Smile CDR build was created

43.19.1.1.2hapiVersion

Contains HAPI FHIR library version information:

  • version - The HAPI FHIR library version string (e.g., "7.6.0")
  • buildNumber - The build number for the HAPI FHIR library (typically "NA")
  • buildTimestamp - ISO 8601 timestamp when the HAPI FHIR library was built

43.19.1.2Error Responses

43.19.1.2.1403 Forbidden

If the request is made without the required ACCESS_ADMIN_JSON permission:

{
  "timestamp": "2025-01-15T12:34:56.789Z",
  "status": 403,
  "error": "Forbidden",
  "message": "Access is denied",
  "path": "/version"
}

43.19.1.3Usage Examples

This endpoint is commonly used for:

  • Support requests: Providing exact version information when reporting issues
  • System monitoring: Automated tools checking deployed software versions
  • Compatibility verification: Ensuring compatible versions across environments
  • Troubleshooting: Diagnosing version-related issues

43.19.1.4Notes

  • This endpoint does not accept any query parameters
  • The response format is consistent and does not vary based on configuration
  • The endpoint returns HTTP 200 OK on successful requests
  • All timestamps are in ISO 8601 format