Early adopter

2024-03-14

TWG

Removed mismatched fields "donorWeightKg", "donorHeightCm", "numberOfTransfusions", "numberOfPregnancies" from IDM_RES endpoints.

Affected payloads:

• /api/v2/infectiousDiseaseMarkerResultRequest (IDM_RES)
  
  • Request body: response object
• /api/v2/infectiousDiseaseMarkerResultRetrieve (IDM_RES)
  
  • Response body: messages.originalMessage.response object

2025-07-30

11586

v2.0

Early adopter

Renamed "address" field to "institutionPaying" in TYP_REQ endpoints.

Affected payloads

:

• /api/v2/

• extendedTypingRequestRequest (

• TYP_

• REQ)
  
  • Request body: request object
• /api/v2/

• extendedTypingRequestRetrieve (

• TYP_

• REQ)

•  
  
  • Response body: messages.originalMessage.request object

12920

v2.0

Early adopter

Added optional field "ccr5" to marker object in IDM_REQ and

IDM_RES endpoints.

Affected payloads:

• /api/v2/

• infectiousDiseaseMarkerRequestRequest (IDM_

• REQ)
  
  • Request body:

• • request.marker object
• /api/v2/

• infectiousDiseaseMarkerRequestRetrieve (IDM_

• REQ)
  
  • Response body: messages.originalMessage.

• • request.marker object
• /api

• /v2/

• infectiousDiseaseMarkerResultRequest (

• IDM_

• RES)
  
  • Request body: response.marker object
• /api/v2/

• infectiousDiseaseMarkerResultRetrieve (

• IDM_

• RES)
  

• • Response body: messages.originalMessage.response.marker object

12469

v2.0

Change patient object to optional & add optional field "referenceMessageId"

TWG

Changed patient object to optional in TXT_MSG endpoints.

Added optional field "referenceMessageId" to request object in TXT_MSG

endpoints.

Affected payloads:

• /api/v2/

• textMessageRequest
  • Request body: request object
• /api/v2/

• textMessageRetrieve
  • Response body: messages.originalMessage.request object

11596

v2.0

TWG

Removed "requestId" field from endpoints where "messageReferenceId" is used for identification.

Affected payloads:

• /

• api/v2/

• extendedTypingResponseRequest (

• TYP_

• RES)
  • Request body: response object
• /api/v2/

• extendedTypingResponseRetrieve (

• TYP_RES)
  • Response body: messages.originalMessage.response object
• /api/v2/

• infectiousDiseaseMarkerResultRequest (IDM_RES)

• • Request body: response object
• /api/v2/infectiousDiseaseMarkerResultRetrieve (IDM_RES)
  • Response body: messages.originalMessage.response object

• /api/v2/

• requestCancellationRequest (

• REQ_

• CAN)
  • Request body:

• • message object
• /api/v2/

• requestCancellationRetrieve (

• REQ_

• CAN)
  • Response body: messages.originalMessage.

• • message object
• /api/v2/

• requestRejectedRequest (

• NO_RES)
  • Request body:

• • message object
• /api/v2/

• requestRejectedRetrieve (

• NO_RES)
  • Response body: messages.originalMessage.

• • message object
• /api/v2/reservationReleaseRequest
  • Request body: request object
• /api/v2/reservationReleaseRetrieve
  • Response body: messages.originalMessage.request object
• /api/v2/

• reservationResponseRequest (

• RSV_

• RES)
  • Request body: response object
• /api/v2/

• reservationResponseRetrieve (

• RSV_

• RES)

• • Response body: messages.originalMessage.response object
• /api/v2/resultReminderRequest (RES_REM)
  • Request body: message object
• /api/v2/resultReminderRetrieve (RES_REM)
  • Response body: messages.originalMessage.message object

• /api/v2/

• sampleArrivalRequest (SMP_ARR)
  • Request body:

• • message object
• /api/v2/

• sampleArrivalRetrieve (SMP_ARR)
  • Response body: messages.originalMessage.

• • message object
• /

• api/v2/

• sampleInfoRequest (

• SMP_

• INFO)
  • Request body: message object
• /api/v2/

• sampleInfoRetrieve (

• SMP_

• INFO)
  • Response body: messages.originalMessage.message object
• /api/v2/

• sampleResponseRequest (

• SMP_RES)
  • Request body: response object
• /api/v2/

• sampleResponseRetrieve (

• SMP_RES)
  • Response body: messages.originalMessage.response object
• /api/v2/

• textMessageRequest (

• TXT_

• MSG)
  • Request body: request object

• /api/v2/

• textMessageRetrieve (

• TXT_

• MSG)
  • Response body: messages.originalMessage.request object

11555

v2.0

Early adopter

Added enum values "G", "M", "B", "H", "O" to "antiToxoplasmosisStatus" and "antiEbvStatus" fields within idm object in TYP_RES, IDM_RES, RSV_RES, SMP_RES endpoints.

G = IgG positive, IgM negative; 
M = IgG negative, IgM positive; 
B = Both IgG and IgM positive; 
H = IgG positive, IgM not tested; 
O = IgG negative, IgM not tested.

Affected payloads:

• /api/v2/extendedTypingResponseRequest (TYP_RES)
  • Request body: donor.idm object
• /api/v2/extendedTypingResponseRetrieve (TYP_RES)
  • Response body: messages.originalMessage.donor.idm object
• /api/v2/infectiousDiseaseMarkerResultRequest (IDM_RES)
  • Request body: response.idm & donor.idm objects
• /api/v2/infectiousDiseaseMarkerResultRetrieve (IDM_RES)
  • Response body: messages.originalMessage.response.idm & messages.originalMessage.donor.idm objects
• /api/v2/reservationResponseRequest (RSV_RES)
  • Request body: donor.idm object
• /api/v2/reservationResponseRetrieve (RSV_RES)
  • Response body: messages.originalMessage.donor.idm object
• /api/v2/sampleResponseRequest (SMP_RES)
  • Request body: response.idm object
• /api/v2/sampleResponseRetrieve (SMP_RES)
  • Response body: messages.originalMessage.responce.idm object

13032

v2.0

TWG

Renamed "donorCcr5Status" to "ccr5" and added "abo", " rhesus" fields to response object in IDM_RES endpoints.

Affected payloads:

• /api/v2/infectiousDiseaseMarkerResultRequest (IDM_RES)
  • Request body: response object
• /api/v2/infectiousDiseaseMarkerResultRetrieve (IDM_RES)
  • Response body: messages.originalMessage.response object

&

Added "ccr5" field to response object in SMP_RES endpoints.

Affected payloads:

• /api/v2/sampleResponseRequest (SMP_RES)
  • Request body: response object
• /api/v2/sampleResponseRetrieve (SMP_RES)
  • Response body: messages.originalMessage.response object

12353

v2.0

Early adopter

Removed "mixedLymphocyteCultureGvh", "mixedLymphocyteCultureHvg", "gvhReactivityPercent", "hvgReactivityPercent", "other"  ("other" field present in the marker object only) fields from TYP_RES, IDM_REQ, IDM_RES, RSV_RES endpoints.

Affected payloads:

• /api/v2/extendedTypingResponseRequest (TYP_RES)
  • Request body: donor.idm object
• /api/v2/extendedTypingResponseRetrieve (TYP_RES)
  • Response body: messages.originalMessage.donor.idm object
• /api/v2/infectiousDiseaseMarkerRequestRequest (IDM_REQ)
  • Request body: request.marker object
• /api/v2/infectiousDiseaseMarkerRequestRetrieve (IDM_REQ)
  • Response body: messages.originalMessage.request.marker object
• /api/v2/infectiousDiseaseMarkerResultRequest (IDM_RES)
  • Request body: response.marker, response.idm & donor.idm objects
• /api/v2/infectiousDiseaseMarkerResultRetrieve (IDM_RES)
  • Response body: messages.originalMessage.response.marker, messages.originalMessage.response.idm & messages.originalMessage.donor.idm objects
• /api/v2/reservationResponseRequest (RSV_RES)
  • Request body: donor.idm object
• /api/v2/reservationResponseRetrieve (RSV_RES)
  • Response body: messages.originalMessage.donor.idm object

&

Moved "mixedLymphocyteCultureGvh", "mixedLymphocyteCultureHvg", "gvhReactivityPercent", "hvgReactivityPercent" fields from response.idm to a new object response.lymphocyteReactivity in SMP_RES endpoints.

Affected payloads:

• /api/v2/sampleResponseRequest (SMP_RES)
  • Request body: response.idm → response.lymphocyteReactivity object
• /api/v2/sampleResponseRetrieve (SMP_RES)
  • Response body: messages.originalMessage.response.idm → messages.originalMessage.response.lymphocyteReactivity object

12465

v2.0

TWG

Added optional field reservedPatientWmdaId  to the Donor In Response block in TYP_RES, IDM_RES, RSV_RES endpoints.

Affected payloads:

• /api/v2/extendedTypingResponseRequest (TYP_RES)
  • Request body: donor object
• /api/v2/extendedTypingResponseRetrieve (TYP_RES)
  • Response body: messages.originalMessage.donor object
• /api/v2/infectiousDiseaseMarkerResultRequest (IDM_RES)
  • Request body: donor object
• /api/v2/infectiousDiseaseMarkerResultRetrieve (IDM_RES)
  • Response body: messages.originalMessage.donor object
• /api/v2/reservationResponseRequest (RSV_RES)
  • Request body: donor object
• /api/v2/reservationResponseRetrieve (RSV_RES)
  • Response body: messages.originalMessage.donor object

12354

v2.0

TWG

Added required object hla with optional fields to response object in TYP_RES endpoints.

Affected payloads:

• /api/v2/extendedTypingResponseRequest (TYP_RES)
  • Request body: response → response.hla object
• /api/v2/extendedTypingResponseRetrieve (TYP_RES)
  • Response body: messages.originalMessage.response → messages.originalMessage.response.hla object

11587

v2.0

Added enum value "Q" (Questionable) to the fields (antiCmvStatus, cmvNatStatus, hepatitisBSurfaceAntigenStatus, antiHepatitisBCoreStatus, antiHepatitisBSurfaceAntigenStatus, hepatitisBNatStatus, antiHepatitisCStatus, hepatitisCNatStatus, antiHepatitisEStatus, hepatitisENatStatus, antiHiv12Status, hiv1NatStatus, hivP24Status, antiHtlvStatus, syphilisStatus, westNileVirusNatStatus, chagasNatStatus, antiEbvStatus, antiToxoplasmosisStatus, parvoB19NatStatus) within idm object in TYP_RES, IDM_RES, RSV_RES, SMP_RES endpoints 

Affected payloads:

• /api/v2/extendedTypingResponseRequest (TYP_RES)
  • Request body: donor.idm object
• /api/v2/extendedTypingResponseRetrieve (TYP_RES)
  • Response body: messages.originalMessage.donor.idm object
• /api/v2/infectiousDiseaseMarkerResultRequest (IDM_RES)
  • Request body: donor.idm & response.idm objects
• /api/v2/infectiousDiseaseMarkerResultRetrieve (IDM_RES)
  • Response body: messages.originalMessage.donor.idm & messages.originalMessage.response.idm objects
• /api/v2/reservationResponseRequest (RSV_RES)
  • Request body: donor.idm object
• /api/v2/reservationResponseRetrieve (RSV_RES)
  • Response body: messages.originalMessage.donor.idm object
• /api/v2/sampleResponseRequest (SMP_RES)
  • Request body: response.idm object
• /api/v2/sampleResponseRetrieve (SMP_RES)
  • Response body: messages.originalMessage.response & messages.originalMessage.response.idm objects

12464

v2.0

Added optional fields "phone", "fax", "email" to organisation object in TYP_RES, IDM_REQ, SMP_REQ endpoints.

Affected payloads:

• /api/v2/extendedTypingRequestRequest (TYP_REQ)
  
  • Request body: request.institutionPaying.organisation object
• /api/v2/extendedTypingRequestRetrieve (TYP_REQ) 
  
  • Response body: messages.originalMessage.request.institutionPaying.organisation object
• /api/v2/infectiousDiseaseMarkerRequestRequest (IDM_REQ)
  • Request body: request.institutionPaying.organisation object
• /api/v2/infectiousDiseaseMarkerRequestRetrieve (IDM_REQ)
  • Response body: messages.originalMessage.request.institutionPaying.organisation object
• /api/v2/sampleRequestRequest (SMP_REQ)
  • Request body: request.institutionPaying.organisation object
• /api/v2/sampleRequestRetrieve (SMP_REQ)
  • Response body: messages.originalMessage.request.institutionPaying.organisation object

&

Renamed "ctSampleType" field to "sampleType" in TYP_REQ, SMP_ARR endpoints.

Affected payloads:

• /api/v2/extendedTypingResponseRequest (TYP_RES)
  • Request body: response object
• /api/v2/extendedTypingResponseRetrieve (TYP_RES)
  • Response body: messages.originalMessage.response object
• /api/v2/sampleArrivalRequest (SMP_ARR)
  • Request body: message object
• /api/v2/sampleArrivalRetrieve (SMP_ARR)
  • Response body: messages.originalMessage.message object

10835

v2.0

2025-10-01

13195

v2.1

13289

v2.1

Added optional serology object with two fields to hla.a, hla.b, hla.c, hla.drb1, hla.dqb1 withing hla object for TYP_RES, IDM_RES, RSV_RES, SMP_RES, TYP_REQ, Generic Request, IDM_REQ, RSV_REQ, SMP_REQ, Update Registered Patient endpoints.

Affected payloads:

• /api/v2/extendedTypingResponseRequest (TYP_RES)
  • Request body: donor.hla.a, donor.hla.b, donor.hla.c, donor.hla.drb1, donor.hla.dqb1 & response.hla.a, response.hla.b, response.hla.c, reponse.hla.drb1, response.hla.dqb1 objects
• /api/v2/extendedTypingResponseRetrieve (TYP_RES)
  • Response body: messages.originalMessage.donor.hla.a, messages.originalMessage.donor.hla.b, messages.originalMessage.donor.hla.c, messages.originalMessage.donor.hla.drb1, messages.originalMessage.donor.hla.dqb1 & messages.originalMessage.response.hla.a, messages.originalMessage.response.hla.b, messages.originalMessage.response.hla.c, messages.originalMessage.response.hla.drb1, messages.originalMessage.response.hla.dqb1 objects
• /api/v2/infectiousDiseaseMarkerResultRequest (IDM_RES)
  • Request body: donor.hla.a, donor.hla.b, donor.hla.c, donor.hla.drb1, donor.hla.dqb1 objects
• /api/v2/infectiousDiseaseMarkerResultRetrieve (IDM_RES)
  • Response body: messages.originalMessage.donor.hla.a, messages.originalMessage.donor.hla.b, messages.originalMessage.donor.hla.c, messages.originalMessage.donor.hla.drb1, messages.originalMessage.donor.hla.dqb1 objects
• /api/v2/reservationResponseRequest (RSV_RES)
  • Request body: donor.hla.a, donor.hla.b, donor.hla.c, donor.hla.drb1, donor.hla.dqb1 objects
• /api/v2/reservationResponseRetrieve (RSV_RES)
  • Response body: messages.originalMessage.donor.hla.a, messages.originalMessage.donor.hla.b, messages.originalMessage.donor.hla.c, messages.originalMessage.donor.hla.drb1, messages.originalMessage.donor.hla.dqb1 objects

• /api/v2/sampleResponseRequest (SMP_RES)
  • Request body: response.hla.a, response.hla.b, response.hla.c, reponse.hla.drb1, response.hla.dqb1 objects
• /api/v2/sampleResponseRetrieve (SMP_RES)
  • Response body: messages.originalMessage.response.hla.a, messages.originalMessage.response.hla.b, messages.originalMessage.response.hla.c, messages.originalMessage.response.hla.drb1, messages.originalMessage.response.hla.dqb1 objects
• /api/v2/extendedTypingRequestRequest (TYP_REQ)
  • Request body: patient.hla.a, patient.hla.b, patient.hla.c, patient.hla.drb1, patient.hla.dqb1 objects
• /api/v2/extendedTypingRequestRetrieve (TYP_REQ)
  • Response body: messages.originalMessage.patient.hla.a, messages.originalMessage.patient.hla.b, messages.originalMessage.patient.hla.c, messages.originalMessage.patient.hla.drb1, messages.originalMessage.patient.hla.dqb1 objects
• /api/v2/GenericRequestRequest
  • Request body: patient.hla.a, patient.hla.b, patient.hla.c, patient.hla.drb1, patient.hla.dqb1 objects
• /api/v2/GenericRequestRetrieve
  • Response body: messages.originalMessage.patient.hla.a, messages.originalMessage.patient.hla.b, messages.originalMessage.patient.hla.c, messages.originalMessage.patient.hla.drb1, messages.originalMessage.patient.hla.dqb1 objects
• /api/v2/infectiousDiseaseMarkerRequestRequest (IDM_REQ)
  • Request body: patient.hla.a, patient.hla.b, patient.hla.c, patient.hla.drb1, patient.hla.dqb1 objects
• /api/v2/infectiousDiseaseMarkerRequestRetrieve (IDM_REQ)
  • Response body: messages.originalMessage.patient.hla.a, messages.originalMessage.patient.hla.b, messages.originalMessage.patient.hla.c, messages.originalMessage.patient.hla.drb1, messages.originalMessage.patient.hla.dqb1 objects
• /api/v2/reservationRequestRequest (RSV_REQ)
  • Request body: patient.hla.a, patient.hla.b, patient.hla.c, patient.hla.drb1, patient.hla.dqb1 objects
• /api/v2/reservationRequestRetrieve (RSV_REQ)
  • Response body: messages.originalMessage.patient.hla.a, messages.originalMessage.patient.hla.b, messages.originalMessage.patient.hla.c, messages.originalMessage.patient.hla.drb1, messages.originalMessage.patient.hla.dqb1 objects
• /api/v2/sampleRequestRequest (SMP_REQ)
  • Request body: patient.hla.a, patient.hla.b, patient.hla.c, patient.hla.drb1, patient.hla.dqb1 objects
• /api/v2/sampleRequestRetrieve (SMP_REQ)
  • Response body: messages.originalMessage.patient.hla.a, messages.originalMessage.patient.hla.b, messages.originalMessage.patient.hla.c, messages.originalMessage.patient.hla.drb1, messages.originalMessage.patient.hla.dqb1 objects
• /api/v2/updateRegisteredPatientRequest
  • Request body: patient.hla.a, patient.hla.b, patient.hla.c, patient.hla.drb1, patient.hla.dqb1 objects
• /api/v2/updateRegisteredPatientRetrieve
  • Response body: messages.originalMessage.patient.hla.a, messages.originalMessage.patient.hla.b, messages.originalMessage.patient.hla.c, messages.originalMessage.patient.hla.drb1, messages.originalMessage.patient.hla.dqb1 objects

10817

v2.0

Soft fail is triggered when confirming Reservation Response (RSV_RES) endpoint without reserving the donor.

If "response.confirmed" is TRUE and "donor.status" ≠ RS (reserved), API will respond with a soft fail - 200 OK and include a warning:

"responseType": /"warning"
    "wmdaRemarks": 
        "remarkType": "invalidInformation"
        "description": "Donor Status must be RS (reserved) when confirming reservation"

13535

v2.0

Added following validations:

1. "donor.dateOfBirth" field is required and nullable: false. Used in TYP_RES, IDM_RES, RSV_RES endpoints
2. "hlaNomenclatureVersion" field has maxLenght: 5. Used in TYP_RES, SMP_RES endpoints
3. "organisationId" is required, has minLength: 5, maxLength: 19, and the pattern: ^\\d{4}\\w{1,19}$. Used in institutionPaying object in TYP_REQ. IDM_REQ, SMP_REQ. Also in institutionToSendSampleTo object in SMP_REQ endpoint.
4. "donorId" field in Embedded Donor Block (donor in request object) has the following validation in TYP_REQ, genericRequest, IDM_REQ, REQ_CAN, NO_RES, RSV_REQ, reservationRelease, RES_REM, SMP_ARR, SMP_INFO, SMP_REQ, SMP_RES, TXT_MSG endpoints:

• If donorType is adult, then grid must be provided with minLength: 19, maxLength: 19
• If donorType is adcu, then adcuId must be provided with minLength: 13, maxLength: 13
• If donorType is cbu, then cordId must be provided with minLength: 1, maxLength: 17

13617

v2.0

Added new optional field "antiChagasStatus" to the marker and idm objects in IDM_REQ (request.marker object), IDM_RES (response.marker , response.idm & donor.idm objects), TYP_RES (donor.idm object), RSV_RES (donor.idm object), SMP_RES (response.idm object) endpoints .

Affected payloads:

• /api/v2/infectiousDiseaseMarkerRequestRequest (IDM_REQ)
  • Request body: request.marker object
• /api/v2/infectiousDiseaseMarkerRequestRetrieve (IDM_REQ)
  • Response body: messages.originalMessage.request.marker object
• /api/v2/infectiousDiseaseMarkerResultRequest (IDM_RES)
  • Request body: response.marker, response.idm & donor.idm objects
• /api/v2/infectiousDiseaseMarkerResultRetrieve (IDM_RES)
  • Response body: messages.originalMessage.response.marker, messages.originalMessage.response.idm  &  messages.originalMessage.donor.idm objects
• /api/v2/extendedTypingResponseRequest (TYP_RES)
  • Request body: donor.idm object
• /api/v2/extendedTypingResponseRetrieve (TYP_RES)
  • Response body: messages.originalMessage.donor.idm object
• /api/v2/reservationResponseRequest (RSV_RES)
  • Request body: donor.idm object
• /api/v2/reservationResponseRetrieve (RSV_RES)
  • Response body: messages.originalMessage.donor.idm object
• /api/v2/sampleResponseRequest (SMP_RES)
  • Request body: response.idm object
• /api/v2/sampleResponseRetrieve (SMP_RES)
  • Response body: messages.originalMessage.response.idm object

13562

v2.0

Add "remark" field to the

/api/v2/sampleResponseRequest (SMP_RES)

endpoint

Optional field "remark" added to the response object in

SMP_RES

endpoint.

Affected payloads:

• /api/v2/

• sampleResponseRequest (

• SMP_

• RES)
  • Request body:

• • response object
• /api/v2/

• sampleResponseRetrieve (

• SMP_

• RES)
  • Response body: messages.originalMessage.

• • response object

13562

v2.0

Change hla object. Required loci must have either DNA or Serology

Changed "dna" and "field1" to optional for loci A, B, DRB1 in hla object. Present in Embedded Adult Donor Block (TYP_RES, IDM_RES, RSV_RES) & Embedded Patient Block (TYP_REQ, Generic Request, IDM_REQ, RSV_REQ, SMP_REQ, Update Registered Patient). 

For required loci (A, B, DRB1) either DNA or Serology must be provided.

Affected payloads:

• /api/v2/extendedTypingResponseRequest (TYP_RES)
  • Request body: donor.hla object

• /api/v2/

• extendedTypingResponseRetrieve (

• TYP_RES)
  • Response body: messages.originalMessage.donor.hla object
• /api/v2/

• infectiousDiseaseMarkerResultRequest (IDM_RES)
  • Request body: donor.hla object
• /api/v2/infectiousDiseaseMarkerResultRetrieve (IDM_RES)
  • Response body: messages.originalMessage.donor.hla object

• /api/v2/

• reservationResponseRequest (

• RSV_RES)
  • Request body: donor.

• • hla object
• /api/v2/

• reservationResponseRetrieve (

• RSV_RES)
  • Response body: messages.originalMessage.donor.

• • hla object

• /api/v2/

• extendedTypingRequestRequest (

• TYP_

• REQ)
  • Request body:

• •  patient.hla object
• /api/v2/

• extendedTypingRequestRetrieve (

• TYP_

• REQ)
  • Response body: messages.originalMessage.

• • patient.hla object
• /api/v2/

• GenericRequestRequest
  • Request body: 

• • patient.

• • hla object
• /api/v2/

• GenericRequestRetrieve
  • Response body: messages.originalMessage.

• • patient.

• • hla object
• /api/v2/

• infectiousDiseaseMarkerRequestRequest (

• IDM_

• REQ)
  • Request body:

• •  patient.

• • hla object
• /api/v2/

• infectiousDiseaseMarkerRequestRetrieve (

• IDM_

• REQ)
  • Response body: messages.originalMessage.

• • patient.hla object

• /api/v2/

• reservationRequestRequest (

• RSV_REQ)
  • Request body: patient.hla object

• /api/v2/

• reservationRequestRetrieve (

• RSV_

• REQ)
  • Response body: messages.originalMessage.patient.hla object
• /api/v2/

• sampleRequestRequest (SMP_

• REQ)
  • Request body: patient.hla object

• /api/v2/

• sampleRequestRetrieve (

• SMP_

• REQ)
  • Response body: messages.originalMessage.patient.hla object
• /api/v2/updateRegisteredPatientRequest
  • Request body: patient.hla object
• /api/v2/

• updateRegisteredPatientRetrieve
  • Response body

• • : messages.originalMessage.patient.hla object

 All fields in hla object changed to optional in SMP_RES endpoint.

 Affected payloads:

• /api/v2/sampleResponseRequest (SMP_RES)
  • Request body: response

• • .hla object
• /api/v2/sampleResponseRetrieve (SMP_RES)
  • Response body: messages.originalMessage.response

• • .hla object

13795

v2.0

Updated the regex pattern for the patient's dateOfBirth field to support both full ISO 8601 date (YYYY-MM-DD) and year-only (YYYY).

New regex pattern: "^\\d{4}(-[01]\\d-[0-3]\\d)?$"

  Affected payloads:

• /api/v2/

• extendedTypingRequestRequest (

• TYP_

• REQ)

• • Request body: patient.dateOfBirth field
• /api/v2/extendedTypingRequestRetrieve (TYP_REQ)
  • Response body: messages.originalMessage.patient.dateOfBirth field
• /api/v2/GenericRequestRequest
  • Request body: patient.dateOfBirth field
• /api/v2/GenericRequestRetrieve
  • Response body: messages.originalMessage.patient.dateOfBirth field

• /api/v2/

• infectiousDiseaseMarkerRequestRequest (

• IDM_

• REQ)
  • Request body:

• •  patient.dateOfBirth field
• /api/v2/

• infectiousDiseaseMarkerRequestRetrieve (

• IDM_

• REQ)
  • Response body: messages.originalMessage.

• • patient.

• • dateOfBirth field
• /api/v2/

• reservationRequestRequest (

• RSV_REQ)
  • Request body: 

• • patient.

• • dateOfBirth field
• /api/v2/

• reservationRequestRetrieve (

• RSV_REQ)
  • Response body: messages.originalMessage.

• • patient.

• • dateOfBirth field
• /api/v2/

• sampleRequestRequest (

• SMP_

• REQ)
  • Request body:

• •  patient.dateOfBirth field
• /api/v2/

• sampleRequestRetrieve (

• SMP_

• REQ)
  • Response body:

• • messages.originalMessage.

• • patient.

• • dateOfBirth field
• /api/v2/

• updateRegisteredPatientRequest
  • Request body:

• •  patient.dateOfBirth field
• /api/v2/

• updateRegisteredPatientRetrieve
  • Response body: messages.originalMessage.

• • patient.dateOfBirth field

13698

v2.0

Made drb1 optional in the HLA object for the Donor in Response block

.

Affected payloads:

• api/v2/

• extendedTypingResponseRequest (

• TYP_RES)
  • Request body:

• •  donor.hla.drb1 field
• /api/v2/

• extendedTypingResponseRetrieve (

• TYP_RES)
  • Response body: messages.originalMessage.

• • donor.hla.drb1 object
• /api/v2/

• infectiousDiseaseMarkerResultRequest (

• IDM_RES)
  • Request body: donor.hla.drb1 object
• /api/v2/

• infectiousDiseaseMarkerResultRetrieve (

• IDM_RES)

• • Response body: messages.originalMessage.donor.hla.drb1 object
• /api/v2/

• reservationResponseRequest (

• RSV_RES)
  • Request body:

• •  donor.hla.drb1 object
• /api/v2/

• reservationResponseRetrieve (

• RSV_RES)
  • Response body: messages.originalMessage.

• • donor.

• • hla.drb1 object

14412

v2.0

Rename textMessage endpoint.

Add Embedded Attachment block to multiple endpoints

/api/v2/textMessage endpoint renamed to /api/v2/infoMessage.

Added optional Embedded Attachment block (attachment object) to the root-level of the request body for endpoints: TYP_REQ, TYP_RES, SMP_REQ, SMP_RES, SMP_INFO, SMP_ARR, IDM_REQ, IDM_RES, reservationReleaseRequest, RSV_REQ, RSV_RES, REQ_CAN, NO_RES, RES_REM, genericRequestRequest, genericRequestRequest, infoMessage.

12350

v2.1

13534

v2.1

Endpoint that allows registry to response to requestCancellationRequest (REQ_CAN) and indicate whether or not it can carry out cancellation request.

13174

v2.1

9793

v2.1

9794

v2.1

13198

v2.2

13197

v2.2

13188

v2.2

11816

v2.2

11726

v2.2