Skip to main content

EmbryoScope (Vitrolife)

Status
Available
Region
Global
Vendor
Vitrolife
Data flow
Wells, gradings, images: EmbryoScope → wawa. wawa never writes to EmbryoScope
Connectivity
ES Public API over HTTPS (port 4000); Site-to-Site VPN or customer-managed public URL
Set up by
Clinic account administrator

wawa connects to the EmbryoScope server to link a cycle's embryos to their wells and pull back well locations, gradings and images into the embryology record. An account administrator turns syncing on from Configuration.

Requirements​

  • The ES Public API service installed on the ES Server. This is a separate service from EmbryoViewer: the API listens on port 4000, EmbryoViewer on 3010.
  • The API reachable over HTTPS (TLS 1.2) through a Site-to-Site VPN or a customer-managed public URL restricted to wawa's egress IPs.
  • Anything in front of the API (proxy, gateway) must forward requests to port 4000 unchanged and must not challenge or filter them. Without a session the API itself answers every path with an empty 401, so that alone is not a sign of a gateway; an HTML error page instead of an empty response is.
  • The ES Public API limits how fast it can be called and issues sessions that last 60 minutes. wawa paces its requests, waits and retries when the server asks it to slow down, and renews sessions itself.

What we need from you​

One entry for the ES Server that runs the ES Public API. The API serves every instrument connected to that server, so one entry covers them all:

InputWhat to give usExample
NameA label for the serverEmbryoScope
URLThe ES Public API address: scheme, host and port 4000, no pathhttps://es-server.clinic.internal:4000
Hostname the server answers toOptional. Only if the server's certificate is issued for a hostname that is not the one in the URL, for example when wawa reaches it by its private IP over a VPN: wawa connects to the URL's address but sends this name for TLS (SNI) and the HTTP Host header. A hostname or IPv4 address on its own, without https://, a port or a path; use an IP address when the certificate lists only IP addresses.embryoscope.clinic.example
UsernameA WSA user created in the EmbryoScope software for wawawawa-api
PasswordThat user's password (case-sensitive)
CA rootOptional. Only if the ES Server's certificate is not from a public CA: your internal root CA, or the server's certificate itself if it is self-signed. Your account admin adds it in wawa and selects it on the Certificates tab (see TLS certificates). wawa trusts it alongside the public CAs, for every entry on the account.

wawa reads from the entry marked as the default. An account's only entry is always the default. Keep a single EmbryoScope server per account: links to EmbryoScope patients, treatments and embryos are only valid on the server that issued them.

Share the username and password over a secure channel, or enter them in wawa yourself. Also name your IT contact for the network path, and your Vitrolife contact if the API service still needs installing.

Setting it up​

  1. Go to Settings → Integrations → EmbryoScope.
  2. On Configuration, turn on Enable integration and save. With it off, wawa does not sync from EmbryoScope or show its data on cycles.
  3. On EmbryoScopes, add the ES Server with the inputs above. Credentials are encrypted and not shown again.
  4. If the ES Server's certificate is not from a public CA, an account admin turns on TLS certificates on Configuration, saves, and chooses the CA root on the Certificates tab.
  5. Click Test to confirm wawa can reach it and sign in.

While the integration is being validated with your clinic, Show validation notice on Configuration shows a notice at the top of the culture tab of every cycle synced with EmbryoScope, asking staff to confirm EmbryoScope details against EmbryoScope. It is on for a new integration; an account admin turns it off once validation is complete.

Linking a cycle​

Each cycle is linked to the EmbryoScope patient and treatment that hold its embryos. Treatment names are typed freely in EmbryoScope, so the link is made once per cycle rather than guessed. wawa finds the patient in EmbryoScope by their EmbryoScope Patient ID, which starts as the Patient ID recorded in wawa. If your EmbryoScope holds patients under another number, such as an older hospital number, enter that one instead: it is used only to find the patient in EmbryoScope, and wawa's Patient ID does not change. Once a patient is linked, their next cycle starts with the EmbryoScope Patient ID they were linked by.

  1. On the cycle, open Cycle → Sync EmbryoScope.
  2. Check the patient and their EmbryoScope Patient ID, then click Find in EmbryoScope.
  3. Compare the name and date of birth EmbryoScope holds with wawa's. wawa warns when the dates of birth differ.
  4. Choose the treatment and click Link. Each treatment shows its fertilisation date and number of embryos. The one fertilised nearest the cycle is selected, and treatments already linked to another cycle are marked.

Using it​

Once a cycle is linked, Sync EmbryoScope opens the sync. Click Sync: wawa updates the embryology record before it answers, then downloads the images in the background, so they appear a little later. It only reads: it never creates or changes patients, treatments or anything else in EmbryoScope.

Linked cycles are also synced automatically three times a day while their embryos are in culture: every active cycle with a fertilisation in the last 8 days. Each cycle's sync starts two minutes after the one before, so the ES Server is not asked for everything at once.

When wawa's fertilised embryos, discarded ones included, and the embryos in the linked EmbryoScope treatment are equal in number, wawa pairs them itself, matching wawa's embryo numbers in order against EmbryoScope's slides and wells. When the numbers differ, for example because the slide also holds immature eggs, Sync EmbryoScope first asks the embryologist to match them: each well is listed with its label and EmbryoScope fate next to a choice of the cycle's embryos, fertilised or not, pre-filled in order. Any well can be left unpaired. A pairing, once made, is kept for every later sync, and wawa warns when EmbryoScope no longer lists a paired embryo.

Syncing is safe to repeat. Values only update when they change, gradings and locations entered in wawa are kept, and images are not downloaded twice: each development day, up to 8 days, keeps the latest image EmbryoScope held when a sync first reached that day. The fertilisation time recorded in wawa is never changed, and images are timed from it. Each sync also keeps a copy of what EmbryoScope holds for each paired embryo (its details, annotations and evaluation, and its iDAScore when EmbryoScope has one), replacing the copy from the sync before.

wawa lists its data requests to EmbryoScope, with any error they returned, on the Events tab (Settings → Integrations → EmbryoScope → Events). Image downloads are not listed.

Viewing an embryo's EmbryoScope data​

Each sync also sets an embryo's fate from EmbryoScope's: Transfer, Freeze and Avoid become transferred, cryopreserved and discarded, and Undecided or Unknown return it to no fate. Only the fate changes: no cryo record or discard is created. A fate someone has changed in wawa since EmbryoScope set it is kept, and the Fate column on the culture tab then also shows EmbryoScope's (for example "EmbryoScope: Freeze") so the difference is visible.

An embryo that EmbryoScope holds data for has an icon next to its ID. Click it to open the copy wawa kept at the last sync, in three tabs:

  • Overview: the iDAScore, with the hours after fertilisation it was scored at and the model version; every embryo detail EmbryoScope holds, such as the well, the fertilisation time and method, and the fate; and the evaluation, when EmbryoScope holds one. Values are shown as EmbryoScope sends them.
  • Annotations: each annotation with its time in hours after fertilisation and its value, earliest first. For cleavage events (t2 to t9), the value shown is the hours they happened at.
  • Images: the images downloaded from EmbryoScope, in the order they were taken.

When an embryo also has Chloe data, the icon opens Chloe's data instead.

Unlinking a cycle​

Open Cycle → Unlink EmbryoScope and confirm. This removes the cycle's link to its treatment, the pairing of its embryos and the copy of their EmbryoScope data. Images that came from EmbryoScope are removed unless they are attached to a grading, and gradings and fates EmbryoScope wrote are cleared unless someone has changed them in wawa. A paired embryo's location is cleared while it is still a well, such as "Well 3"; any other location is kept. The patient link is kept. To link the cycle to a different treatment, unlink it first.