Skip to main content

Cryohexagon

EU

Cryostorage integration with Cryohexagon.

Location id​

Cryohexagon records on /api/v1/cryo/cryohexagon include location_id. It is the clinic site id from /api/v1/locations, the same id patients already return. Use it to tell sites apart when they share an account. account_id stays the account.

location_id is the tank's clinic:

  • Tanks and canisters use that tank's clinic.
  • Samples, thaws and exports use the clinic of the Cryohexagon tank holding the record's devices. The value is null when the tank has no clinic, or when those devices do not all share one clinic. A sample counts all of its devices, including those a thaw or export has taken, but its devices list holds only the devices still in storage. The taken devices are in that thaw's or export's devices.
  • Moves return from_location_id and to_location_id. Each is that tank's clinic, or null when the tank has no clinic.
  • Activities use the device's tank clinic, or the sample's shared device clinic. The value is null when the record is not placed in a tank.
  • Each device also includes devices[].location.tank.location_id, so a mixed sample is still readable per device.

devices[].location.id is the cryo storage slot, not the site. The tank's location string is the free-text label and is unchanged.

Patients keep location_id as the patient's own clinic. That can differ from the tank the stock sits in.

The field is null until the Cryohexagon tank's clinic is set.

Tank capacity​

The v1 tank endpoints (/api/v1/cryo/tanks and /api/v1/cryo/cryohexagon/tanks) return two distinct values:

  • canister_capacity is the number of canisters currently recorded in the tank.
  • canister_limit is the specified maximum number of canisters the tank can hold, or null when that maximum is unknown. Use this field for capacity, not canister_capacity.

Biopsy request dates​

The v1 Cryohexagon samples, exports and thaws responses (both list and update) include biopsy details at devices[].embryo_devices[].biopsies[].biopsy.requested_at.

  • A known request date is returned as an ISO 8601 date-time string with a timezone, for example "2026-07-14T08:55:07.299+01:00".
  • An unknown request date on an imported biopsy is returned as JSON null. The requested_at key remains present; other biopsy details are still returned.
  • Unknown means unknown. Do not substitute the sample's freeze date, a result date, or another event date, and do not infer chronology from an unknown request date.

Consumers must accept both a date-time string and null. Existing dated values are unchanged. Clients that require a non-null timestamp must update their models and date parsing before processing imported biopsies with unknown request dates.