Appearance

Versioned Read ​

The versioned read interaction accesses a specific version of a resource. The available versions of a resource can be discovered via the history interaction.

GET [base]/[type]/[id]/_history/[vid]

On success, Blaze returns the requested version of the resource with a 200 OK. As with the read interaction, the response contains an ETag header with the version id and a Last-Modified header with the transaction time of that version:

HTTP/1.1 200 OK
Last-Modified: Tue, 24 Jun 2025 09:03:22 GMT
ETag: W/"23"

Binary Resources Since 1.12.0 ​

As with the read interaction, every version of a Binary resource can be retrieved either as FHIR resource or in binary form. Blaze decides based on the Accept header of the request:

  • application/fhir+json and application/fhir+xml (as well as */* or a missing Accept header) return the Binary resource itself, with its content Base64 encoded in Binary.data,
  • every other media type returns the raw content of Binary.data.
sh
curl -H 'Accept: application/pdf' "http://localhost:8080/fhir/Binary/AT4S2E5FQTPTIQPP/_history/2"

The Content-Type header of such a binary response is taken from Binary.contentType of that version, defaulting to application/octet-stream if that property is missing. Blaze doesn't match it against the media types requested in the Accept header.

Handling Errors ​

Status CodeDescription
400 Bad RequestThe id given in the URL is invalid. Ids are restricted to 64 characters of A-Z, a-z, 0-9, - and ..
404 Not FoundThe given version of the resource doesn't exist. This includes version ids that aren't non-negative integers.
410 GoneThe given version marks the deletion of the resource. The ETag and Last-Modified headers refer to the deletion.

All error responses contain an OperationOutcome with details in the body. 404 Not Found responses carry a Cache-Control: no-cache header because a resource version with the given id may come into existence later.

Deleted Histories ​

Versions removed via the delete history interaction are no longer accessible and will result in a 404 Not Found. The current version of the resource stays accessible.