Skip to main content

RI Witness (CooperSurgical)

Status
Available
Region
Global
Vendor
CooperSurgical
Data flow
Patients, partners and cycles: wawa → RI Witness
Connectivity
SOAP 1.2 over HTTPS; Site-to-Site VPN or customer-managed public URL
Set up by
Clinic account administrator

wawa pushes patients, partners and treatment cycles to RI Witness whenever clinicians create or update a cycle, so the witnessing terminals always show the right person and cycle without re-keying. With Automatically sync patients on, a patient's details are also sent whenever the patient is added or their details change, without waiting for a cycle. The flow is one way: wawa to RI Witness.

What is sent​

  • Patient details: demographics and contact information.
  • Partner relationships, when the cycle involves a partner.
  • Treatment cycle data: protocol, start date, cycle type, and the end date unless Send cycle end dates is off for the server (see below).

Requirements​

  • The RI Witness Web Service installed on a clinic server (from the CooperSurgical release bundle). wawa talks to it with SOAP 1.2.
  • A network path: Site-to-Site VPN, or a customer-managed public URL restricted to wawa's egress IPs. Any reverse proxy in front must pass SOAP 1.2 requests unchanged.
  • Every patient and partner to sync needs an identity-management ID, a last name and a date of birth, and the cycle needs a start date. Anything missing is skipped and logged on the Events tab.
  • RI Witness takes identity-management IDs of up to 16 characters. An ID ending in a clinic suffix added on import is always sent with the suffix shortened to three letters, and the ID sent is shown in the event's request payload. An ID still over 16 characters, or one whose shortened form belongs to another patient, is skipped and logged on the Events tab, including from Synchronise now.
  • Only open cycles are created in RI Witness. A cycle that ends before it is sent is not created, and one RI Witness already holds is still updated.
  • A cycle is created in RI Witness under the reference WW- followed by its wawa cycle number (for example WW-748467), so it cannot be mistaken for a cycle from an earlier system numbered the same way. Cycles already in RI Witness keep the reference they were created under.
  • RI Witness links a patient to one partner at a time, so a cycle is not sent while either patient has another open cycle with a different partner, or with none. It is logged on the Events tab, naming the cycle in the way.

What we need from you​

Per RI Witness server (one per site if each site has its own)

InputWhat to give usExample
NameA label for the serverMain lab
URLThe web service base address, including any per-clinic sub-path. Don't include /WitnessWebService.asmx; wawa adds it. HTTPS.https://witness.clinic.internal/RIWitness
Hostname the server answers toOptional. Only if the server answers to a hostname that is not the one in the URL, for example when wawa reaches it by its private IP over a VPN and its certificate is issued for a name: 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.witness.clinic.example
Username and passwordA Basic-auth account for wawa. Both are needed for authentication to be sent.
CA rootOptional. Only if the 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 RI Witness server on the account.
DefaultThe server used for clinics without their own assignment
Send cycle end datesOn by default: wawa closes a cycle in RI Witness when it ends in wawa. Switch it off where the lab closes cycles in RI Witness itself; wawa then never sends an end date to that server. Changing it does not resend cycles and does not clear an end date RI Witness already holds.On

Per clinic

  • Which server serves each clinic, or the default.

For the pilot

  • The identity-management IDs of a few test patients, to limit syncing to them before switching on for everyone.
  • Your IT contact for the server and network path, and your CooperSurgical contact if the web service is not yet installed.

Setting it up​

  1. Go to Settings → Integrations → RI Witness.
  2. If a 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.
  3. On Stations, add each server with the inputs above and click Test.
  4. On Clinics, choose the server for each clinic (blank uses the default).
  5. On Configuration:
    • Enable integration is the master switch; with it off nothing is sent.
    • Automatically sync cycles pushes cycles as they are created and updated.
    • Automatically sync patients sends a patient's details as soon as they are added or changed, without waiting for a cycle. It works independently of Automatically sync cycles.
    • Patient IDs for auto-sync limits syncing to the listed identity-management IDs (comma- or space-separated). Leave it empty to sync everyone.
    • Uppercase surnames sends surnames in capital letters (for example, Smith → SMITH). It is off by default and leaves first names and names stored in wawa unchanged. It applies the next time a patient is sent; saving the setting does not resend existing patients.

A manual sync (Synchronise now on a cycle) needs only the integration enabled: it sends the cycle even with automatic sync off or the patient not on the list. Each sync is recorded on the Events tab, with the specific error if one fails.