Canadian Transplant Registry Release Preparation Board 2025

How to Use This Site

This page is intended to be used by CTR Users as well as by provincial partner IT groups in order to prepare for upcoming releases of the Canadian Transplant Registry, access documentation for what is currently in use, and quickly check the availability of accessible CTR environments.

In sections below, you will see a live display of environment availability status, a list of upcoming scheduled changes to CTR environments, resource documents intended for both users of CTR as well as partner IT developers/testers, and links to all available CTR environments and their current setup.

For any questions on content, or to suggest changes, please contact customer support at transplantregistry@blood.ca.

Environment Availability Status
All environments are available.
If you are experiencing issues, please contact our CTR Customer Solutions Team via email or at 1-855-274-2889. If you are calling outside of normal office hours, dial '1' to speak to on-call CTR Customer Support personnel.

Upcoming Events

  • 2025-01-07
  • CTR Data Refresh in UAT ON and UAT QC *COMPLETE*

    Beginning at 11:30am ET on 2025-01-07, CTR UAT ON and UAT QC will be refreshed with the 2025-01-06 dataset. Environments will be offline during the refresh.
  • 2025-01-14
  • CTR 5.6.11.0 Release Notes (English) are now available in the Future Release Documents section.

    French Release Notes to be available by February 3, 2025.
  • 2025-01-27
  • Update: Version 2.1 of the CTR Integration Guide is now available.

    Changes are minor. URLs updated to account for new UAT environments.
  • 2025-01-31
  • UAT Updates - Upgrade to 5.6.11.0

    UAT Upgrades to occur as follows:

    1. Train Prod *COMPLETE*

    Other environments to be added as requested. Upgrade will begin at 10:00 ET. Affected environments will be offline during the refresh.
  • 2025-02-03
  • Modifications de version (Notes de mise à jour) pour la version 5.6.11.0

    Ce document est désormais disponible en français dans l'onglet Documents des versions futures.
  • To be completed by March 2025
  • CTR User Acceptance Testing Environments at v5.5

    CTR UATs that have not yet been upgraded to v5.6.11.0 will be done by March, 2025. Exact dates pending confirmation from affected users.
  • 2025-05-01
  • CTR PRODUCTION - Upgrade to 5.6.11.0 - 6:00am ET

    CTR Production will be offline during the upgrade. Outage window has been set for 3 hours, though the actual upgrade is anticipated to be completed and released back to users in less time.


Documents Outlining CTR Changes

The following section contains documents outlining changes in current, upcoming, and past releases. These documents are written for both an IT and user audience in plain language in both English and French. Where applicable, images are also included to show how UI changes will appear to a CTR user.

In addition, there is also a folder containing documents for use by webservice partners to demonstrate how a provincial health system may connect to the transplant registry.

Finally, for larger program updates, such as the 2024-12-04 updates to the Deceased Kidney program, a folder will be available containing release notes, links to policy updates, and other documents that are intended to help both IT and CTR users prepare for the updates.

This folder contains the Change Documents for upcoming CTR Releases.

Documents will be added here as they become available.

Change Document (Release Notes) for Version 5.6.11.0 (Updated 2025-02-03)

This English language document outlines the changes which are found in v5.6.11.0 and covers both UI and Web Service updates. Please note, this document contains all changes in CTR from v5.6.10.1 through to 5.6.11.0.

Modifications de version (Notes de mise à jour) pour la version 5.6.11.0 (Modifié 2025-02-03)

Ce document en français décrit les changements qui se trouvent dans la v5.6.11.0 et couvre les mises à jour de l'interface utilisateur et du service Web. Veuillez noter que ce document contient toutes les modifications apportées au CTR de la version 5.6.10.1 à la version 5.6.11.0.

CTR Integration Guide v2.1 (Revised 2025-01-16)

The information in this guide describes the technical configuration that allows some amount of automated exchange of data between CTR and connecting provincial systems.

This folder contains the Change Documents for the current release within CTR Production

Change Document (Release Notes) for Version 5.6.10.1 (Revised 2024-10-24)

This English language document outlines the changes which are found in v5.6.10.1 and covers both UI and Web Service updates. Please note, this document contains all changes in CTR from v5.5.9.1 through to 5.6.10.1.

Modifications de version (Notes de mise à jour) pour la version 5.6.10.1 (Modifié 2024-10-24)

Ce document en français décrit les changements qui se trouvent dans la v5.6.10.1 et couvre les mises à jour de l'interface utilisateur et du service Web. Veuillez noter que ce document contient toutes les modifications apportées au CTR de la version 5.5.9.1 à la version 5.6.10.1.

CTR Integration Guide v2.1 (Revised 2025-01-16)

The information in this guide describes the technical configuration that allows some amount of automated exchange of data between CTR and connecting provincial systems.

This folder contains documents and URLs for those accessing CTR Production via webservices.

CTR Integration Guide v2.1 (Revised 2025-01-16)

The information in this guide describes the technical configuration that allows some amount of automated exchange of data between CTR and connecting provincial systems.

CTR HLA Typing Dictionary 2018-07-12

This spreadsheet contains the current HLA molecular and serological equivalents, and current HLA Serum antigens supported by CTR. Note: Clicking this link may download the spreadsheet to your device.

Webservices - All CTR3 Methods

This link will bring you to the CTR Javadocs listing of all valid CTR3 webservice methods.

Webservices - Facilities List

This link will bring you to the CTR Javadocs listing of all facilities available in CTR.

Webservices - Lookup Tables

This link will bring you to the CTR Javadocs listing of lookup tables in CTR.

This folder contains documents to support the changes to IPOS Kidney eligibility released in CTR v5.6 on 2024-12-04.

Change Document (Release Notes) for Version 5.6.10.1 (Revised 2024-10-24)

This English language document outlines the changes which are found in v5.6.10.1 and covers both UI and Web Service updates. Please note, this document contains all changes in CTR from v5.5.9.1 through to 5.6.10.1.

Modifications de version (Notes de mise à jour) pour la version 5.6.10.1 (Modifié 2024-10-24)

Ce document en français décrit les changements qui se trouvent dans la v5.6.10.1 et couvre les mises à jour de l'interface utilisateur et du service Web. Veuillez noter que ce document contient toutes les modifications apportées au CTR de la version 5.5.9.1 à la version 5.6.10.1.

Change Document (Release Notes) for Version 5.5.9.1 (created 2024-03-13)

This English language document outlines the changes which are found in v5.5.9.1 and covers both UI and Web Service updates. Please note, this document contains all changes in CTR from v5.4.8.0 through to 5.5.9.1.

Modifications de version (Notes de mise à jour) pour la version 5.5.9.1 (créé 2024-03-13)

Ce document en français décrit les changements qui se trouvent dans la v5.5.9.1 et couvre les mises à jour de l'interface utilisateur et du service Web. Veuillez noter que ce document contient toutes les modifications apportées au CTR de la version 5.4.8.0 à la version 5.5.9.1.

Change Document (Release Notes) for Version 5.4.8.0 (created 2023-03-05)

This English language document outlines the changes which are found in v5.4.8.0 and covers both UI and Web Service updates. Please note, this document contains all changes in CTR from v5.2.8.1 through to 5.4.8.0.

Modifications de version (Notes de mise à jour) pour la version 5.4.8.0 (créé 2023-03-05)

Ce document en français décrit les changements qui se trouvent dans la v5.4.8.0 et couvre les mises à jour de l'interface utilisateur et du service Web. Veuillez noter que ce document contient toutes les modifications apportées au CTR de la version 5.2.8.1 à la version 5.4.8.0.

Change Document (Release Notes) for Version 5.2.8.1 (Revised 2022-09-12)

This English language document outlines the changes which are found in v5.2.8.1 and covers both UI and Web Service updates.

Modifications de version (Notes de mise à jour) pour la version 5.2.8.1 (Modifié 2022-09-12)

Ce document en français décrit les changements qui se trouvent dans la v5.2.8.1 et couvre les mises à jour de l'interface utilisateur et du service Web.

Addendum to CTR 5.1 and CTR 5.2 Change Documents - IPOS Kidney Eligibility Updates - 2022-08-12

This document further clarifies IPOS Kidney eligibility updates which are found in v5.1.19.1, v5.2.8.1, and upcoming in 5.3.x.x for both UI and Web Service users.

Change Document (Release Notes) for Version 5.1.19.1

This document outlines the changes which are found in v5.1.19.1 and covers both UI and Web Service updates.

IPOS Kidney - Web Service support for Pre-Emptive v01

The changes detailed in this document will impact the inputs (requests) and outputs (responses) of the following web service methods, available in the CTR3 endpoint: addRecipientByNationalRecipientId, updateRecipientByNationalRecipientId, and findRecipientByNationalRecipientId.

DWL Kidney Eligibility

This flowchart outlines when the patient is DWL kidney allocation eligibile.

DWL HSP IPOS Kidney Eligibility

This document outlines changes to the HSP Eligibility criteria for a recipient seeking participation in the Donor Waitlist kidney allocation.

DWL - Willing to Cross Eligibility

This flowchart outlines the WTC values to be considered in allocation for the Donor Waitlist.

Policies - Interprovincial Organ Sharing of Kidneys

The Canadian Transplant Registry (CTR) identifies transplant opportunities for patients who are waiting for a kidney transplant and who are pediatric or highly sensitized to Human Leukocyte Antigens (HLA). Although these policies have been approved they are not considered active until implemented through the CTR IPOS Kidney project.

This folder contains the Change Documents from superceded CTR releases.

Change Document (Release Notes) for Version 5.5.9.1 (created 2024-03-13)

This English language document outlines the changes which are found in v5.5.9.1 and covers both UI and Web Service updates. Please note, this document contains all changes in CTR from v5.4.8.0 through to 5.5.9.1.

Modifications de version (Notes de mise à jour) pour la version 5.5.9.1 (créé 2024-03-13)

Ce document en français décrit les changements qui se trouvent dans la v5.5.9.1 et couvre les mises à jour de l'interface utilisateur et du service Web. Veuillez noter que ce document contient toutes les modifications apportées au CTR de la version 5.4.8.0 à la version 5.5.9.1.

Change Document (Release Notes) for Version 5.4.8.0 (created 2023-03-05)

This English language document outlines the changes which are found in v5.4.8.0 and covers both UI and Web Service updates. Please note, this document contains all changes in CTR from v5.2.8.1 through to 5.4.8.0.

Modifications de version (Notes de mise à jour) pour la version 5.4.8.0 (créé 2023-03-05)

Ce document en français décrit les changements qui se trouvent dans la v5.4.8.0 et couvre les mises à jour de l'interface utilisateur et du service Web. Veuillez noter que ce document contient toutes les modifications apportées au CTR de la version 5.2.8.1 à la version 5.4.8.0.

Change Document (Release Notes) for Version 5.2.8.1 (Revised 2022-09-12)

This English language document outlines the changes which are found in v5.2.8.1 and covers both UI and Web Service updates.

Modifications de version (Notes de mise à jour) pour la version 5.2.8.1 (Modifié 2022-09-12)

Ce document en français décrit les changements qui se trouvent dans la v5.2.8.1 et couvre les mises à jour de l'interface utilisateur et du service Web.

Addendum to CTR 5.1 and CTR 5.2 Change Documents - IPOS Kidney Eligibility Updates - 2022-08-12

This document further clarifies IPOS Kidney eligibility updates which are found in v5.1.19.1, v5.2.8.1, and upcoming in 5.3.x.x for both UI and Web Service users.

Change Document (Release Notes) for Version 5.1.19.1

This document outlines the changes which are found in v5.1.19.1 and covers both UI and Web Service updates.

User Acceptance Testing and Production Environment Links

The panels below provide access to applicable URLs for available CTR environments and their intended usage. Cards display the current CTR version, the installed dataset, available web service endpoints, and other settings as applicable.

To receive access to a CTR UAT environment, please contact our CTR Customer Solutions Team via email at transplantregistry@blood.ca or call 1-855-274-2889 between 8am and 5pm ET.

If you have forgotten your password, or need to reset it, you can click here for self service instructions: Password Management.

All Available CTR Environments

There are fourteen UAT environments in addition to the CTR Production environment.

Details of all environments are listed below.

CTR Production

IPOS Kidney: Enabled

Click for more detail

Train Prod

Upcoming version of CTR Production

Settings in this environment will mimic settings of the upcoming release into Production. This environment is available for use by all.

IPOS Kidney: Enabled

Click for more detail

UAT Prod

Current version of CTR Production

Settings in this test environment will remain at consistent with the CTR version that is currently in Production. This environment is available for use by all.

IPOS Kidney: Enabled

Click for more detail

UAT Dev

This environment is available for use by all.

IPOS Kidney: Enabled

Click for more detail

UAT QA

This environment is available for use by all.

IPOS Kidney: Enabled

Click for more detail

UAT Gen

This environment is available for use by all.

IPOS Kidney: Enabled

Click for more detail

UAT Gen2

This environment is available for use by all.

IPOS Kidney: Enabled

Click for more detail

UAT Gen3

This environment is available for use by all.

IPOS Kidney: Enabled

Click for more detail

UAT Gen4

This environment is available for use by all.

IPOS Kidney: Enabled

Click for more detail

UAT BC

This environment is exclusive to BC partners.

IPOS Kidney: Enabled

Click for more detail

UAT BC2

This environment is exclusive to BC partners.

IPOS Kidney: Enabled

Click for more detail
UAT BC2

Updated: 2024-09-03 13:35 ET

This environment is exclusive to BC partners.

Version

5.6.10.1

Dataset

2024-07-02

Notes

Paediatric Pre-Emptive HSP Eligibility ON.

Web URL

https://uat-bc2.transplantregistry.ca

CTR1 Endpoints

CTR1 External DonorCTR1 External RecipientCTR1 External Offer

cPRA Calculator Endpoint

CTR1 cPRA Calculator Service

CTR2 Endpoint

CTR2 WSDL

CTR3 Endpoint

CTR3 WSDL

UAT ON

This environment is exclusive to Ontario partners.

IPOS Kidney: Enabled

Click for more detail

UAT ON2

This environment is exclusive to Ontario partners.

IPOS Kidney: Enabled

Click for more detail

UAT QC

This environment is exclusive to Quebec partners.

IPOS Kidney: Enabled

Click for more detail

UAT QC2

This environment is exclusive to Quebec partners.

IPOS Kidney: Enabled

Click for more detail

UAT QC

This environment is exclusive to Quebec partners.

IPOS Kidney: Enabled

Click for more detail

UAT QC2

This environment is exclusive to Quebec partners.

IPOS Kidney: Enabled

Click for more detail

Train Prod

Upcoming version of CTR Production

Settings in this environment will mimic settings of the upcoming release into Production. This environment is available for use by all.

IPOS Kidney: Enabled

Click for more detail

UAT Prod

Current version of CTR Production

Settings in this test environment will remain at consistent with the CTR version that is currently in Production. This environment is available for use by all.

IPOS Kidney: Enabled

Click for more detail

UAT QA

This environment is available for use by all.

IPOS Kidney: Enabled

Click for more detail

UAT Dev

This environment is available for use by all.

IPOS Kidney: Enabled

Click for more detail

UAT Gen

This environment is available for use by all.

IPOS Kidney: Enabled

Click for more detail

UAT Gen2

This environment is available for use by all.

IPOS Kidney: Enabled

Click for more detail

UAT Gen3

This environment is available for use by all.

IPOS Kidney: Enabled

Click for more detail

UAT Gen4

This environment is available for use by all.

IPOS Kidney: Enabled

Click for more detail

UAT ON

This environment is exclusive to Ontario partners.

IPOS Kidney: Enabled

Click for more detail

UAT ON2

This environment is exclusive to Ontario partners.

IPOS Kidney: Enabled

Click for more detail

Train Prod

Upcoming version of CTR Production

Settings in this environment will mimic settings of the upcoming release into Production. This environment is available for use by all.

IPOS Kidney: Enabled

Click for more detail

UAT Prod

Current version of CTR Production

Settings in this test environment will remain at consistent with the CTR version that is currently in Production. This environment is available for use by all.

IPOS Kidney: Enabled

Click for more detail

UAT QA

This environment is available for use by all.

IPOS Kidney: Enabled

Click for more detail

UAT Dev

This environment is available for use by all.

IPOS Kidney: Enabled

Click for more detail

UAT Gen

This environment is available for use by all.

IPOS Kidney: Enabled

Click for more detail

UAT Gen2

This environment is available for use by all.

IPOS Kidney: Enabled

Click for more detail

UAT Gen3

This environment is available for use by all.

IPOS Kidney: Enabled

Click for more detail

UAT Gen4

This environment is available for use by all.

IPOS Kidney: Enabled

Click for more detail

UAT BC

This environment is exclusive to BC partners.

IPOS Kidney: Enabled

Click for more detail

UAT BC2

This environment is exclusive to BC partners.

IPOS Kidney: Enabled

Click for more detail
UAT BC2

Updated: 2024-09-03 13:35 ET

This environment is exclusive to BC partners.

Version

5.6.10.1

Dataset

2024-07-02

Notes

Paediatric Pre-Emptive HSP Eligibility ON.

Web URL

https://uat-bc2.transplantregistry.ca

CTR1 Endpoints

CTR1 External DonorCTR1 External RecipientCTR1 External Offer

cPRA Calculator Endpoint

CTR1 cPRA Calculator Service

CTR2 Endpoint

CTR2 WSDL

CTR3 Endpoint

CTR3 WSDL

Train Prod

Upcoming version of CTR Production

Settings in this environment will mimic settings of the upcoming release into Production. This environment is available for use by all.

IPOS Kidney: Enabled

Click for more detail

UAT Prod

Current version of CTR Production

Settings in this test environment will remain at consistent with the CTR version that is currently in Production. This environment is available for use by all.

IPOS Kidney: Enabled

Click for more detail

UAT QA

This environment is available for use by all.

IPOS Kidney: Enabled

Click for more detail

UAT Dev

This environment is available for use by all.

IPOS Kidney: Enabled

Click for more detail

UAT Gen

This environment is available for use by all.

IPOS Kidney: Enabled

Click for more detail

UAT Gen2

This environment is available for use by all.

IPOS Kidney: Enabled

Click for more detail

UAT Gen3

This environment is available for use by all.

IPOS Kidney: Enabled

Click for more detail

UAT Gen4

This environment is available for use by all.

IPOS Kidney: Enabled

Click for more detail