Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: V1.01

...

FieldDetails
wmdaId*integer
nullable: false

example: 1234

ID provided by the WMDA

patientId*string
maxLength: 17

nullable: false

example: 99991234P

MUST Start with ION of patient registry. Organisation unique identifier for patient. Cannot be set unless "legalTerms" is set to "true". Do not use real names here.

hla*{...}
idm{...}
dateOfBirthstring($date)
nullable: true

maxLength: 10

example: 1961-05-27
diagnosis{...}
diseasePhase

string
nullable: true

Enum:
Array [ 48 ]

ethnicity

string
nullable: true

Enum:
Array [ 20 ]

poolCountryCodestring
maxLength: 2

pattern: ^[A-Z]{2}

nullable: true

example: NL

ISO 3166-1 alpha-2 Country Code (capitalized)

abo

string
nullable: true

Enum:
Array [ 4 ]

rhesus

string
nullable: true

Enum:
Array [ 2 ]

weightinteger
nullable: true

minimum: 1

maximum: 999

example: 76
sex

string
nullable: true

Enum:
Array [ 2 ]

firstNamestring
maxLength: 30

nullable: true

example: John

First (given name) of the patient

lastNamestring
maxLength: 30

nullable: true

example: Doe

Last (family name) of the patient

6.1.4 Embedded Donor Block (donor in request)

In EMDIS, the following messages are linked to the donor updates:

  • IDM_RES
  • TYP_RES
  • NO_RES
  • RSV_RES

These four will be replaced with the Match-Connect API endpoints that have the donor details embedded in the message. Respective endpoints of IDM_RES and TYP_RES will deliver new IDM and new typing details, and all the mentioned endpoints will also inform the patient registry of the new donor status.

These donor updates are for the receiving registry (patient registry) only and will not be updated in the central HUB. So the sending (donor) registry is responsible for sending a DIFF upload to the S&M system in parallel to keep information in sync.

case the embedded donor block is part of a message type that may not result in updates of donor-related data, the "embedded donor block (donor in request" block is used. 

Only sending a grid, cordId or adcuId for message types with static donor information enhances privacy and security through data minimization.

Donor typeDetails
adult
Expand
title...

grid*

string
nullable: true

maxLength: 19

minLength: 19

example: 9991012070433202000
cbu
Expand
title...

cordId*

string
maxLength: 17
example: CB1234567

CBU Identification2 (formerly CB_ID)

adcu
Expand
title...

adcuId*

string
minLength: 13

maxLength: 13
example: A99991412345612N

N/A in EMDIS, available in the future

6.1.5 Embedded Donor Block (donor in response)

In EMDIS, the following messages are linked to the donor updates:

  • TYP_RES
  • IDM_RES
  • RSV_RES
  • NO_RES

These four will be replaced with the Match-Connect API endpoints that have the donor details embedded in the message. Respective endpoints of IDM_RES and TYP_RES will deliver new IDM and new typing details, and all the mentioned endpoints will also inform the patient registry of the new donor status.

The corresponding endpoints in Match-Connect are:

  • extendedTypingResponse
  • infectiousDiseaseMarkerResponse
  • reservationResponse
  • requestRejected

These donor updates are for the receiving registry (patient registry) only and will not be updated in the central HUB. So the sending (donor) registry is responsible for sending a DIFF upload to the S&M system in parallel to keep information in sync.

FieldDetails
grid*

string
nullable:true
maxLength: 19
minLength: 19
example: 9991012070433202000

dateOfBirth

string
nullable:true

Donor date of birth

sex

string
nullable:true
Enum: [M, F]

antiCmvStatusstring
nullable:true
Enum: [P, G, M, B, H, O, N]
antiCmvDate

string
nullable:true
maxLength: 10

date of CMV NAT test

hla


Expand
title...

a*

dna* {...}

description: HLA node with DNA

b*

dna* {...}

description: HLA node with DNA

c

dna* {...}

description: HLA node with DNA

drb1*

dna* {...}

description: HLA node with DNA

drb3

dna* {...}

description: HLA node with DNA

drb4

dna* {...}

description: HLA node with DNA

drb5

dna* {...}

description: HLA node with DNA

dqa1

dna* {...}

description: HLA node with DNA

dqb1

dna* {...}

description: HLA node with DNA

dpa1

dna* {...}

description: HLA node with DNA

dpb1

dna* {...}

description: HLA node with DNA

mica

gls* {...}

description: HLA node with GLS

micb

gls* {...}

description: HLA node with GLS

abostring
nullable:true
Enum: [A, B, O, AB]
rhesusstring
nullable:true
Enum: [P, N]
Donor typeDetailsAdult donor
Expand
title...

grid*

string
nullable: true

maxLength: 19

minLength: 19

example: 9991012070433202000
CBU
Expand
title...

cordId*

string
maxLength: 17
example: CB1234567

CBU Identification2 (formerly CB_ID)

ADCU Expand
title...

adcuIdid*

string
minLength: 13

maxLength: 13
example: A99991412345612N

N/A in EMDIS, available in the future

Here is the comparison of the DONOR_CB and the API endpoints: EMDIS  EMDIS vs API.xlsx

6.1.

...

6 Embedded WMDA Response block

The WMDA will provide a standard response to request messages sent to Match-Connect.  Its structure is as follows:

FieldDetails
deliveredAtUtc*string($date-time)

Server-supplied timestamp showing time of Message delivery to receiving registry's inbox queue

referenceMessageId*string($uuid)
responseType*

stringEnum:
Array [ Success, Warning, Failed]

messages can be failed, if the message has a structure or information that prevent delivery to the receiving registry. This could be incorrect JSON structure and non-existent ION or because the receiving registry does not allow messages from your registry. 

receivingRegistryMessageSequenceNumber

integer
example: 12345

Incrementing integer set by WMDA MatchConnect systems that indicates the order in which the messages were received by the WMDA and therefore the order in which messages should be processed. Each receiving registry has its own unique sequence.

wmdaRemarks[...]

6.1.

...

7 Embedded 'generalInformation' Response block

The WMDA will provide a standard response to retrieve messages sent to Match-Connect.  Its structure is as follows:

...

Users should be aware that the functionality to restore messages is limited to 72 hours. After this window, the soft-deleted messages are permanently removed from the system. Also see: section 2.4.7 Message storage retention policies in the Technical Guidelines chapter.

POST
recoverMessages
Expand
titleRequest...
FieldDetails
messageSequenceNumber

integer
example: 12345

Incrementing integer set by WMDA MatchConnect systems that indicates the order in which the messages were received by the WMDA and therefore the order in which messages should be processed. Each receiving registry has its own unique sequence.

Expand
titleResponse...
FieldDetails
isSuccessful (200 OK)boolean
error (400 Bad Requst)

string

example: Bad request.